archive-gh-me/mapillary-js
1
0
Fork 0
mirror of https://github.com/mapillary/mapillary-js.git synced 2026-01-25 14:07:28 +00:00
Code Issues Projects Releases Wiki Activity
mapillary-js/doc
History
dependabot[bot] 1740e147c5 chore(deps): bump prismjs from 1.24.0 to 1.25.0 in /doc 
Bumps [prismjs](https://github.com/PrismJS/prism) from 1.24.0 to 1.25.0.
- [Release notes](https://github.com/PrismJS/prism/releases)
- [Changelog](https://github.com/PrismJS/prism/blob/master/CHANGELOG.md)
- [Commits](https://github.com/PrismJS/prism/compare/v1.24.0...v1.25.0)

---
updated-dependencies:
- dependency-name: prismjs
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2021-11-08 15:10:08 +01:00
..
docs
docs: add component guide
2021-09-01 20:36:42 +02:00
examples
refactor: rename extension example files for consistency
2021-09-01 20:36:42 +02:00
plugins/plugin-overwrite-slug
docs: improve file structure
2021-05-12 17:38:12 +02:00
sidebars
docs: add viewer events example
2021-06-15 14:23:10 +02:00
src
fix: correct raycasting for editor
2021-09-09 11:21:11 +02:00
static
docs: add custom render overview section
2021-06-01 09:49:07 +02:00
.eslintignore
chore: upgrade doc dependencies and three
2021-08-02 10:42:27 +02:00
.eslintrc.js
chore: upgrade doc dependencies
2021-06-23 14:00:50 +02:00
.gitignore
chore: upgrade doc dependencies and three
2021-08-02 10:42:27 +02:00
.prettierignore
chore: upgrade doc dependencies and three
2021-08-02 10:42:27 +02:00
.prettierrc
docs: generate api reference in docusaurus
2021-05-12 17:38:12 +02:00
.stylelintrc.js
refactor: single source for app token
2021-05-13 13:23:27 +02:00
babel.config.js
docs: init docusaurus website
2021-05-12 17:38:12 +02:00
docusaurus.config.js
docs: add single example
2021-05-12 17:38:12 +02:00
docusaurus.docs.config.js
docs: clearer readme and docs intro
2021-09-01 20:36:42 +02:00
mapillary-js.sh
chore: clarify doc script namings
2021-08-02 11:56:25 +02:00
package.json
chore: update docusaurus to 2.0.0-beta.6
2021-09-09 11:21:11 +02:00
README.md
docs: add controlling the viewer guide
2021-09-01 20:36:42 +02:00
typedoc.json
docs: generate api reference in docusaurus
2021-05-12 17:38:12 +02:00
yarn.lock
chore(deps): bump prismjs from 1.24.0 to 1.25.0 in /doc
2021-11-08 15:10:08 +01:00

README.md

MapillaryJS Documentation

This website is built using Docusaurus 2.

Development Workflow

After cloning MapillaryJS, run yarn install && yarn install-mjs in this directory to fetch the documentation dependencies. Then, you can run several commands:

  • yarn install-mjs builds the mapillary-js library and copies its distribution to the src/mapillary-js directory. This step is required for building the docs.
  • yarn ci check for linting/formatting issues.
  • yarn start starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. It omits the API and examples sections for faster iteration.
  • yarn build generates static content into the build directory and can be served using any static contents hosting service.
  • yarn serve serves the static content in the build directory. Navigate to http://localhost:3000/mapillary-js to view the documentation.
  • yarn build-api builds the API reference in the doc/api folder spearately. Running this command is not needed for building the static documentation.
  • yarn clear removes the doc build output.

Deployment

Push to the gh-pages branch.

$ GIT_USER=<your GitHub username> yarn deploy