metrists
v0.2.5
Published
metrists - publish markdown files as a book
Downloads
6
Readme
Metrists
Metrists acts as a Continuous Deployment pipeline for your books. It makes publishing books an incremental, quick and automated process.
Getting Started
Create a new directory and execute the following command:
npx metrists watch --example --noob
Modify the markdown files. You can then publish your book:
npx metrists publish
That's it. You can push your files to a repository and connect your CI/CD pipeline. From now, every time you push to your repository, Metrists will automatically publish your book.
Documentation
Follow the full documentation to get started building your own project.
Features
- Live reload while in watch mode
- Fast and incremental builds
- Static web export
.epub
export (coming soon)
Roadmap
See our docs for more information about where we are taking metrists.
Contributing
This package is a beginner-friendly package. If you don't know where to start, visit Make a Pull Request to learn how to make pull requests.
Please visit Contributing for more info.
Code of Conduct
Please visit Code of Conduct.
License
MIT