The root folder can be found under /src/pages. Edit or add Markdown or React (.js) files.
Since Docusaurus uses MDX as the parsing engine, it can also render React components inside a Markdown document. See all Markdown features in the Docusaurus documentation.
The documentation pages are a standalone Docusaurus application, under /docs/. To run the docs:
cd docs
yarn install
yarn startAlternatively, to just start the docs from the root directory, run yarn start:docs.
To edit the documentation pages, edit or add the Markdown files under /docs.
To update the sidebar menu, edit /docs/sidebars.js.
Edit or add the Markdown files under /blog. Prepend the filename with a date, in the YYYY-MM-DD format.
Add front matter between --- lines to control properties such as the title of the blog post, and the author.
See all Header options in the Docusaurus documentation.
yarn install
yarn startThis command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
First ensure you set the right OBJECTIV_ENVIRONMENT in the environment variables: either development,
staging or production.
development:urlis set to the production environment (https://objectiv.io), the tracker applicationId is set toobjectiv-website-dev, and the tracker endpoint is set tohttps://localhost:5000.staging:urlis set to the staging environment (https://staging.objectiv.io), the tracker applicationId is set toobjectiv-website-staging, and the tracker endpoint is set tohttps://collector.objectiv.io.production:urlis set to the production environment (https://objectiv.io), the tracker applicationId is set toobjectiv-website, and the tracker endpoint is set tohttps://collector.objectiv.io.
Then to build:
yarn buildThis command generates static content into the build directory and can be served using any static contents
hosting service.
This documentation site is built using Docusaurus 2.