mdbook-quickstart

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

mdbook-quickstart

★ 14 Open GitHub ↗

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

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 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)](https://raw.githubusercontent.com/MichaelCurrin/mdbook-quickstart/main/)

[![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

<div align="center">
    
<a href="https://michaelcurrin.github.io/mdbook-quickstart/">
    <img src="/sample.png" alt="Sample screenshot" title="Sample screenshot" width="500" />
</a>
    
<br>
    
[![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)

</div>

## 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)](https://raw.githubusercontent.com/MichaelCurrin/mdbook-quickstart/main/docs/)

</div>

## License

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

mdbook-quickstart

Today's picks

Was this content helpful?

Recent Feedback

mdbook-quickstart

Today's picks

Was this content helpful?

Recent Feedback

Download README