mirror of
https://github.com/Leaflet/Leaflet.git
synced 2025-07-21 23:26:12 +00:00
simplify docs update process on release (#7730)
This commit is contained in:
Vladimir Agafonkin
committed by
GitHub
GitHub
parent
bb04e9567d
commit
9f9c549756
18
RELEASE.md
18
RELEASE.md
@ -1,8 +1,9 @@
|
||||
## Releasing a new version of Leaflet
|
||||
|
||||
- [ ] Update [the changelog](https://github.com/Leaflet/Leaflet/blob/master/CHANGELOG.md) since last release and commit
|
||||
- [ ] Run `npm version <patch | minor | major>`
|
||||
- [ ] Run `npm publish`
|
||||
- [ ] Update [the changelog](https://github.com/Leaflet/Leaflet/blob/master/CHANGELOG.md) since last release and commit.
|
||||
- [ ] Run `npm publish --dry-run` to run all the necessary checks without actually publishing, and make sure it runs successfully.
|
||||
- [ ] Run `npm version <patch | minor | major>` (this will bump the version in `package.json` and create a new tag).
|
||||
- [ ] Run `npm publish` to publish to NPM.
|
||||
- [ ] Verify that the release was correctly published to NPM by checking:
|
||||
- [ ] [Leaflet NPM package page](https://www.npmjs.com/package/leaflet)
|
||||
- [ ] files on [Leaflet unpkg page](https://unpkg.com/leaflet@latest/)
|
||||
@ -11,15 +12,10 @@
|
||||
### Updating docs after the release
|
||||
|
||||
- [ ] Make a new branch for the update
|
||||
- [ ] Write a blog post about the new release and put in `/docs/_posts`
|
||||
- [ ] Update API docs:
|
||||
- [ ] run `npm run docs`
|
||||
- [ ] Copy the built docs from `dist/reference-X.Y.Z.html` to `docs/reference-X.Y.Z.html`, remove content before first and after second "CUT HERE" comment
|
||||
- [ ] Insert YAML front matter, see old `docs/reference-X.Y.Z.html` for reference
|
||||
- [ ] Update `docs/reference.html` to redirect to the new version
|
||||
- [ ] Write a blog post about the new release and put it in `/docs/_posts`
|
||||
- [ ] If necessary to preserve previous version's docs, rename `dist/reference.html` to `dist/reference-X.Y.Z.html` and add it to the list in `docs/reference-versions.html`
|
||||
- [ ] Run `npm run docs` to generate the new `docs/reference.html`
|
||||
- [ ] Run `npm run integrity` and make sure `docs/_config.yml` is updated with new hashes
|
||||
- [ ] Update link to latest release in `docs/download.md`
|
||||
- [ ] Add link to new version reference in `docs/reference-versions.html`
|
||||
- [ ] Update `latest_leaflet_version` (and possibly `latest_leaflet_reference`) in `docs/_config.yml`
|
||||
- [ ] Update the announcement section in `docs/index.html`
|
||||
- [ ] Commit all the changes and submit a PR for someone to review
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
var packageDef = require('../package.json');
|
||||
|
||||
function buildDocs() {
|
||||
|
||||
console.log('Building Leaflet documentation with Leafdoc ...');
|
||||
@ -27,7 +25,7 @@ function buildDocs() {
|
||||
doc.addFile('build/docs-misc.leafdoc', false);
|
||||
|
||||
var out = doc.outputStr();
|
||||
var path = 'dist/reference-' + packageDef.version + '.html';
|
||||
var path = 'docs/reference.html';
|
||||
|
||||
var fs = require('fs');
|
||||
|
||||
|
||||
@ -1,153 +1,128 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>{{ title }}</title>
|
||||
<meta charset="utf-8">
|
||||
---
|
||||
layout: v2
|
||||
title: Documentation
|
||||
bodyclass: api-page
|
||||
---
|
||||
|
||||
<link rel="stylesheet" href="../docs/docs/css/normalize.css" />
|
||||
<link rel="stylesheet" href="../docs/docs/css/main.css" />
|
||||
<link rel="stylesheet" href="../docs/docs/css/reference.css" />
|
||||
<script src="../docs/docs/highlight/highlight.pack.js"></script>
|
||||
<link rel="stylesheet" href="../docs/docs/highlight/styles/github-gist.css" />
|
||||
<link rel="stylesheet" href="leaflet.css" />
|
||||
<script src="leaflet.js"></script>
|
||||
</head>
|
||||
<body class='api-page'>
|
||||
<div class='container'>
|
||||
<h2>Leaflet API reference</h2>
|
||||
|
||||
<!-- CUT HERE FOR docs/reference-*.html -->
|
||||
<p>This reference reflects <strong>Leaflet {{site.latest_leaflet_version}}</strong>. Check <a href='reference-versions.html'>this list</a> if you are using a different version of Leaflet.</p>
|
||||
|
||||
<h2>Leaflet API reference</h2>
|
||||
<div id="toc" class="clearfix">
|
||||
<div class="toc-col map-col">
|
||||
<h4>Map</h4>
|
||||
<ul>
|
||||
<li><a href="#map-example">Usage example</a></li>
|
||||
<li><a href="#map-factory">Creation</a></li>
|
||||
<li><a href="#map-option">Options</a></li>
|
||||
<li><a href="#map-event">Events</a></li>
|
||||
</ul>
|
||||
<h4>Map Methods</h4>
|
||||
<ul>
|
||||
<li><a href="#map-methods-for-modifying-map-state">Modifying map state</a></li>
|
||||
<li><a href="#map-methods-for-getting-map-state">Getting map state</a></li>
|
||||
<li><a href="#map-methods-for-layers-and-controls">Layers and controls</a></li>
|
||||
<li><a href="#map-conversion-methods">Conversion methods</a></li>
|
||||
<li><a href="#map-other-methods">Other methods</a></li>
|
||||
</ul>
|
||||
<h4>Map Misc</h4>
|
||||
<ul>
|
||||
<li><a href="#map-property">Properties</a></li>
|
||||
<li><a href="#map-pane">Panes</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="toc-col">
|
||||
<h4>UI Layers</h4>
|
||||
<ul>
|
||||
<li><a href="#marker">Marker</a></li>
|
||||
<li><a href="#popup">Popup</a></li>
|
||||
<li><a href="#tooltip">Tooltip</a></li>
|
||||
</ul>
|
||||
<h4>Raster Layers</h4>
|
||||
<ul>
|
||||
<li><a href="#tilelayer">TileLayer</a></li>
|
||||
<li><a href="#tilelayer-wms">TileLayer.WMS</a></li>
|
||||
<li><a href="#imageoverlay">ImageOverlay</a></li>
|
||||
<li><a href="#videooverlay">VideoOverlay</a></li>
|
||||
</ul>
|
||||
<h4>Vector Layers</h4>
|
||||
<ul>
|
||||
<li><a href="#path">Path</a></li>
|
||||
<li><a href="#polyline">Polyline</a></li>
|
||||
<li><a href="#polygon">Polygon</a></li>
|
||||
<li><a href="#rectangle">Rectangle</a></li>
|
||||
<li><a href="#circle">Circle</a></li>
|
||||
<li><a href="#circlemarker">CircleMarker</a></li>
|
||||
<li><a href="#svgoverlay">SVGOverlay</a></li>
|
||||
<li><a href="#svg">SVG</a></li>
|
||||
<li><a href="#canvas">Canvas</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="toc-col">
|
||||
<h4>Other Layers</h4>
|
||||
<ul>
|
||||
<li><a href="#layergroup">LayerGroup</a></li>
|
||||
<li><a href="#featuregroup">FeatureGroup</a></li>
|
||||
<li><a href="#geojson">GeoJSON</a></li>
|
||||
<li><a href="#gridlayer">GridLayer</a></li>
|
||||
</ul>
|
||||
<h4>Basic Types</h4>
|
||||
<ul>
|
||||
<li><a href="#latlng">LatLng</a></li>
|
||||
<li><a href="#latlngbounds">LatLngBounds</a></li>
|
||||
<li><a href="#point">Point</a></li>
|
||||
<li><a href="#bounds">Bounds</a></li>
|
||||
<li><a href="#icon">Icon</a></li>
|
||||
<li><a href="#divicon">DivIcon</a></li>
|
||||
</ul>
|
||||
<h4>Controls</h4>
|
||||
<ul>
|
||||
<li><a href="#control-zoom">Zoom</a></li>
|
||||
<li><a href="#control-attribution">Attribution</a></li>
|
||||
<li><a href="#control-layers">Layers</a></li>
|
||||
<li><a href="#control-scale">Scale</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="toc-col">
|
||||
<!-- <h4>Shared Methods</h4> -->
|
||||
<!-- <ul> -->
|
||||
<!-- <li><a href="#evented">Event</a></li> -->
|
||||
<!-- <li><a href="#layers">Layer</a></li> -->
|
||||
<!-- <li><a href="#popup">Popup</a></li> -->
|
||||
<!-- </ul> -->
|
||||
<h4>Utility</h4>
|
||||
<ul>
|
||||
<li><a href="#browser">Browser</a></li>
|
||||
<li><a href="#util">Util</a></li>
|
||||
<li><a href="#transformation">Transformation</a></li>
|
||||
<li><a href="#lineutil">LineUtil</a></li>
|
||||
<li><a href="#polyutil">PolyUtil</a></li>
|
||||
</ul>
|
||||
<h4>DOM Utility</h4>
|
||||
<ul>
|
||||
<li><a href="#domevent">DomEvent</a></li>
|
||||
<li><a href="#domutil">DomUtil</a></li>
|
||||
<li><a href="#posanimation">PosAnimation</a></li>
|
||||
<li><a href="#draggable">Draggable</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="toc-col last-col">
|
||||
<h4>Base Classes</h4>
|
||||
<ul>
|
||||
<li><a href="#class">Class</a></li>
|
||||
<li><a href="#evented">Evented</a></li>
|
||||
<li><a href="#layer">Layer</a></li>
|
||||
<li><a href="#interactive-layer">Interactive layer</a></li>
|
||||
<li><a href="#control">Control</a></li>
|
||||
<li><a href="#handler">Handler</a></li>
|
||||
<!--<li><a class="nodocs" href="#">IFeature</a></li>-->
|
||||
<li><a href="#projection">Projection</a></li>
|
||||
<li><a href="#crs">CRS</a></li>
|
||||
<li><a href="#renderer">Renderer</a></li>
|
||||
</ul>
|
||||
|
||||
<h4>Misc</h4>
|
||||
<ul>
|
||||
<li><a href="#event-objects">Event objects</a></li>
|
||||
<li><a href="#global-switches">global switches</a></li>
|
||||
<li><a href="#noconflict">noConflict</a></li>
|
||||
<li><a href="#version">version</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="toc" class="clearfix">
|
||||
<div class="toc-col map-col">
|
||||
<h4>Map</h4>
|
||||
<ul>
|
||||
<li><a href="#map-example">Usage example</a></li>
|
||||
<li><a href="#map-factory">Creation</a></li>
|
||||
<li><a href="#map-option">Options</a></li>
|
||||
<li><a href="#map-event">Events</a></li>
|
||||
</ul>
|
||||
<h4>Map Methods</h4>
|
||||
<ul>
|
||||
<li><a href="#map-methods-for-modifying-map-state">Modifying map state</a></li>
|
||||
<li><a href="#map-methods-for-getting-map-state">Getting map state</a></li>
|
||||
<li><a href="#map-methods-for-layers-and-controls">Layers and controls</a></li>
|
||||
<li><a href="#map-conversion-methods">Conversion methods</a></li>
|
||||
<li><a href="#map-other-methods">Other methods</a></li>
|
||||
</ul>
|
||||
<h4>Map Misc</h4>
|
||||
<ul>
|
||||
<li><a href="#map-property">Properties</a></li>
|
||||
<li><a href="#map-pane">Panes</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
{{{ body }}}
|
||||
|
||||
<!-- CUT HERE FOR docs/reference-*.html -->
|
||||
|
||||
<div class="toc-col">
|
||||
<h4>UI Layers</h4>
|
||||
<ul>
|
||||
<li><a href="#marker">Marker</a></li>
|
||||
<li><a href="#popup">Popup</a></li>
|
||||
<li><a href="#tooltip">Tooltip</a></li>
|
||||
</ul>
|
||||
<h4>Raster Layers</h4>
|
||||
<ul>
|
||||
<li><a href="#tilelayer">TileLayer</a></li>
|
||||
<li><a href="#tilelayer-wms">TileLayer.WMS</a></li>
|
||||
<li><a href="#imageoverlay">ImageOverlay</a></li>
|
||||
<li><a href="#videooverlay">VideoOverlay</a></li>
|
||||
</ul>
|
||||
<h4>Vector Layers</h4>
|
||||
<ul>
|
||||
<li><a href="#path">Path</a></li>
|
||||
<li><a href="#polyline">Polyline</a></li>
|
||||
<li><a href="#polygon">Polygon</a></li>
|
||||
<li><a href="#rectangle">Rectangle</a></li>
|
||||
<li><a href="#circle">Circle</a></li>
|
||||
<li><a href="#circlemarker">CircleMarker</a></li>
|
||||
<li><a href="#svgoverlay">SVGOverlay</a></li>
|
||||
<li><a href="#svg">SVG</a></li>
|
||||
<li><a href="#canvas">Canvas</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="toc-col">
|
||||
<h4>Other Layers</h4>
|
||||
<ul>
|
||||
<li><a href="#layergroup">LayerGroup</a></li>
|
||||
<li><a href="#featuregroup">FeatureGroup</a></li>
|
||||
<li><a href="#geojson">GeoJSON</a></li>
|
||||
<li><a href="#gridlayer">GridLayer</a></li>
|
||||
</ul>
|
||||
<h4>Basic Types</h4>
|
||||
<ul>
|
||||
<li><a href="#latlng">LatLng</a></li>
|
||||
<li><a href="#latlngbounds">LatLngBounds</a></li>
|
||||
<li><a href="#point">Point</a></li>
|
||||
<li><a href="#bounds">Bounds</a></li>
|
||||
<li><a href="#icon">Icon</a></li>
|
||||
<li><a href="#divicon">DivIcon</a></li>
|
||||
</ul>
|
||||
<h4>Controls</h4>
|
||||
<ul>
|
||||
<li><a href="#control-zoom">Zoom</a></li>
|
||||
<li><a href="#control-attribution">Attribution</a></li>
|
||||
<li><a href="#control-layers">Layers</a></li>
|
||||
<li><a href="#control-scale">Scale</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="toc-col">
|
||||
<h4>Utility</h4>
|
||||
<ul>
|
||||
<li><a href="#browser">Browser</a></li>
|
||||
<li><a href="#util">Util</a></li>
|
||||
<li><a href="#transformation">Transformation</a></li>
|
||||
<li><a href="#lineutil">LineUtil</a></li>
|
||||
<li><a href="#polyutil">PolyUtil</a></li>
|
||||
</ul>
|
||||
<h4>DOM Utility</h4>
|
||||
<ul>
|
||||
<li><a href="#domevent">DomEvent</a></li>
|
||||
<li><a href="#domutil">DomUtil</a></li>
|
||||
<li><a href="#posanimation">PosAnimation</a></li>
|
||||
<li><a href="#draggable">Draggable</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="toc-col last-col">
|
||||
<h4>Base Classes</h4>
|
||||
<ul>
|
||||
<li><a href="#class">Class</a></li>
|
||||
<li><a href="#evented">Evented</a></li>
|
||||
<li><a href="#layer">Layer</a></li>
|
||||
<li><a href="#interactive-layer">Interactive layer</a></li>
|
||||
<li><a href="#control">Control</a></li>
|
||||
<li><a href="#handler">Handler</a></li>
|
||||
<!--<li><a class="nodocs" href="#">IFeature</a></li>-->
|
||||
<li><a href="#projection">Projection</a></li>
|
||||
<li><a href="#crs">CRS</a></li>
|
||||
<li><a href="#renderer">Renderer</a></li>
|
||||
</ul>
|
||||
|
||||
<script src="../docs/docs/js/docs.js"></script>
|
||||
<script src="../docs/docs/js/reference.js"></script>
|
||||
<h4>Misc</h4>
|
||||
<ul>
|
||||
<li><a href="#event-objects">Event objects</a></li>
|
||||
<li><a href="#global-switches">global switches</a></li>
|
||||
<li><a href="#noconflict">noConflict</a></li>
|
||||
<li><a href="#version">version</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</body></html>
|
||||
{{{ body }}}
|
||||
|
||||
@ -6,7 +6,6 @@ kramdown:
|
||||
entity_output: as_input
|
||||
|
||||
latest_leaflet_version: 1.7.1
|
||||
latest_leaflet_reference: 1.7.1
|
||||
|
||||
# Integrity hashes for both leaflet.js and leaflet-src.js
|
||||
# These will be shown in the downloads page
|
||||
|
||||
@ -80,7 +80,7 @@
|
||||
{% if page.title == 'Documentation' %}
|
||||
<span>Docs</span>
|
||||
{% else %}
|
||||
<a href="{{ root }}reference-{{ site.latest_leaflet_reference }}.html">Docs</a>
|
||||
<a href="{{ root }}reference.html">Docs</a>
|
||||
{% endif %}
|
||||
</li>
|
||||
<li>
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -17,5 +17,5 @@ bodyclass: api-page
|
||||
<li><a href='reference-1.4.0.html'>API reference for 1.4.0</a>
|
||||
<li><a href='reference-1.5.1.html'>API reference for 1.5.1</a>
|
||||
<li><a href='reference-1.6.0.html'>API reference for 1.6.0</a>
|
||||
<li><a href='reference-1.7.1.html'>API reference for 1.7.1</a>
|
||||
<li><a href='reference.html'>API reference for 1.7.1</a>
|
||||
</ul></p>
|
||||
|
||||
25068
docs/reference.html
25068
docs/reference.html
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user