pretendo-docker/docs
Matthew Lopez b80c4a6f71
Some checks failed
Build and deploy documentation site / build (push) Has been cancelled
Build and deploy documentation site / deploy (push) Has been cancelled
Enable trailing slash in docs
This should fix a small SEO issue: the canonical URL for each page does not have a trailing slash but GitHub Pages redirects URLs without a trailing slash to the version with a trailing slash. This seems to confuse Google.
2024-12-01 11:25:55 -05:00
..
docs Minor docs wording update 2024-09-05 10:37:58 -04:00
src/css Complete the documentation website overhaul 2024-05-29 21:00:36 -04:00
static Configure docs-only mode and delete other pages 2024-05-25 14:24:05 -04:00
.gitignore Create Docusaurus docs site from template 2024-05-25 14:24:01 -04:00
babel.config.js Reformat docs configuration files 2024-05-25 14:24:05 -04:00
docusaurus.config.ts Enable trailing slash in docs 2024-12-01 11:25:55 -05:00
package-lock.json Bump typescript from 5.6.3 to 5.7.2 in /docs (#186) 2024-11-22 15:22:32 -05:00
package.json Bump typescript from 5.6.3 to 5.7.2 in /docs (#186) 2024-11-22 15:22:32 -05:00
README.md Complete the documentation website overhaul 2024-05-29 21:00:36 -04:00
sidebars.ts Configure docs-only mode and delete other pages 2024-05-25 14:24:05 -04:00
tsconfig.json Reformat docs configuration files 2024-05-25 14:24:05 -04:00

Pretendo Docker Documentation

This website is built using Docusaurus, a modern static website generator.

Build and deploy documentation site

View the live site here

Development

Install dependencies

npm install

Start a local development server

npm start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build the site

npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.