https://github.com/michaelcurrin/mdbook-quickstart

Starter template for an online book or docs site made with Markdown and mdBook 🦀 📙
https://github.com/michaelcurrin/mdbook-quickstart

boilerplate book markdown mdbook quickstart rust starter static-site template

Last synced: 8 months ago
JSON representation

Starter template for an online book or docs site made with Markdown and mdBook 🦀 📙

• Host: GitHub
• URL: https://github.com/michaelcurrin/mdbook-quickstart
• Owner: MichaelCurrin
• License: mit
• Created: 2021-07-01T15:28:35.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2022-11-14T09:18:26.000Z (almost 3 years ago)
• Last Synced: 2024-04-28T05:03:42.061Z (over 1 year ago)
• Topics: boilerplate, book, markdown, mdbook, quickstart, rust, starter, static-site, template
• Language: Makefile
• Homepage: https://michaelcurrin.github.io/mdbook-quickstart/
• Size: 1.24 MB
• Stars: 9
• Watchers: 3
• Forks: 7
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# mdBook Quickstart 🦀 📙

> Starter template for an online book or docs site made with Markdown and mdBook

[![GH Pages Deploy](https://github.com/MichaelCurrin/mdbook-quickstart/workflows/GH%20Pages%20Deploy/badge.svg)](https://github.com/MichaelCurrin/mdbook-quickstart/actions/workflows/main.yml?query=workflow:"GH+Pages+Deploy")

[![GitHub tag](https://img.shields.io/github/tag/MichaelCurrin/mdbook-quickstart?include_prereleases=&sort=semver)](https://github.com/MichaelCurrin/mdbook-quickstart/releases/)

[![License](https://img.shields.io/badge/License-MIT-blue)](#license)

[![Made with Rust](https://img.shields.io/badge/Rust-1-blue?logo=rust&logoColor=white)](https://www.rust-lang.org/)

[![dependency - mdbook](https://img.shields.io/badge/dependency-mdbook-blue)](https://rust-lang.github.io/mdBook/)

[![Hosted with GH Pages](https://img.shields.io/badge/Hosted_with-GitHub_Pages-blue?logo=github&logoColor=white)](https://pages.github.com/)

[![Made with GH Actions](https://img.shields.io/badge/CI-GitHub_Actions-blue?logo=github-actions&logoColor=white)](https://github.com/features/actions)

## Preview



    



    



    




    

[![View site - GH Pages](https://img.shields.io/badge/View_site-GH_Pages-blue?style=for-the-badge)](https://michaelcurrin.github.io/mdbook-quickstart/)

    

[![Use this template](https://img.shields.io/badge/Generate-Use_this_template-2ea44f?style=for-the-badge)](https://github.com/MichaelCurrin/mdbook-quickstart/generate)




## Sample usage

Start a dev server:

```sh

$ make serve

```

Open in the browser.

## Documentation



[![View - Documentation](https://img.shields.io/badge/View-Documentation-blue?style=for-the-badge)](/docs/)



## License

Released under [MIT](/LICENSE) by [@MichaelCurrin](https://github.com/MichaelCurrin).