neoncitylights/mdbook

repository template for generating docs using mdBook, GitHub Pages and GitHub Actions

Markdown Template

A repository template that builds a static documentation site using Markdown and mdBook.

Make a change, commit, push, and see the updates live on your GitHub Pages site!

Features

• Linting markdown files with markdownlint-cli2
• Auto-generated documentation using mdBook and GitHub Pages
• Continuous deployment with GitHub Actions, with fast-build & deploy times (< 30 seconds)
• Dependency updates with Dependabot
• Remote development with GitHub Codespaces

Configure

Tool	File	Documentation
mdBook	book.toml	docs
mdBook	SUMMARY.md	docs
markdownlint-cli2	.markdownlint-cli2.jsonc	docs, example file

Build locally

git clone https://github.com/neoncitylights/mdbook.git
cd mdbook
npm install
npm run build

System requirements

Be sure to also install the following tools:

• Cargo (Rust package manager)
• mdBook (Static site generator with Markdown)

Lint markdown files

• To lint markdown: npm run lint
• To auto-fix lint errors: npm run lint:fix