th1988 / workers-docs-engine

Workers Docs Engine

Note about the project naming

While this project is currently called Workers Docs Engine, it currently contains both the docs engine and content.

The plan is to move the content into either @cloudflare/workers-docs or (-content).

Soon after that, the engine itself will be renamed @cloudflare/cloudflare-docs-engine, and other Cloudflare products in addition to Workers will begin using it.

Developing locally

Running the local development server (localhost:8000):

npm run develop

Testing the build (localhost:9000):

npm run build && npm run serve

Documentation (for the documentation)

See https://developers.cloudflare.com/workers/docs-engine. (Note: This URL is temporary. The content in src/content/docs-engine will soon be broken out to a separate project and deployed to another location.)

Known issues

• @gatsbyjs/gatsby#17506 Console warning about lazy=load images missing dimensions. This is a known issue in Gatsby and the recommendation as of Sept, 2019 is to ignore it.
• Hard page loads with hashes don’t start scrolled when developing locally (e.g. http://localhost:8000/#docs-content).