The basic steps for setting up a development are as follows.
Clone the docs site repo (
@username/my-docs-sitebelow):~/ $ git clone email@example.com:username/my-docs-site.git
npm install:~/ $ cd my-docs-site~/my-docs-site $ npm install
- ~/my-docs-site $ npm run bootstrap
Run the local development server:~/my-docs-site $ npm run develop
localhost:8000in your browser to see your docs site.
At this point, you can make changes to the Markdown files inside the content directory (e.g.
my-docs-site/src/content) to build or improve your docs site.
Watch files for changes
Go to the local repo's root directory and run
npm install:~/cloudflare-docs/products/docs-engine $ cd ../..~/cloudflare-docs $ npm install
developcommand passing the product folder name (the name of a
products/sub-folder) as an argument — for example,
docs-engine:~/cloudflare-docs $ npm run develop -- docs-engine
localhost:8000in your browser to see your docs site. In this example, when you update any files under
cloudflare-docs/products/docs-engine, the development server automatically updates the rendered docs site.
Currently, this script is only available in the . If you are using the Docs Engine with a different documentation repository, you need to stop and restart
npm run develop every time you make changes to files under