https://github.com/neuodev/bookmark
Convert markdown to production ready websites
https://github.com/neuodev/bookmark
Last synced: over 1 year ago
JSON representation
Convert markdown to production ready websites
- Host: GitHub
- URL: https://github.com/neuodev/bookmark
- Owner: neuodev
- Created: 2022-08-19T14:08:00.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-08-20T15:41:03.000Z (almost 4 years ago)
- Last Synced: 2025-03-02T07:02:43.451Z (over 1 year ago)
- Language: Rust
- Homepage:
- Size: 353 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Bookmark
Create static websites out of markdown
# Useage
To start using it make sure you read [install bookmark](./INSTALL.md)
## Start new project
```bash
$ bookmark new # Should see a prompt asking for the book and author names
my-book
├── book.json # Book config
└── src # All markdown file
├── assets/
| └── App.js
└── example.md
```
## Build your project
from within your project folder where `book.json` lives you should call this command
```bash
$ bookmark build
# Output
[Done] Chapter 1 - Intorduction to rust
[Done] Chapter 2 - Closures
```
Should see the generated website in the `dist` directory
**note**: If you will commit your book into a repo make sure to ignore the `dist` folder as you can generate it anytime
## Full commands list
```bash
$ bookmark -h
bookmark
Convert markdown to production ready websites
USAGE:
bookmark.exe
OPTIONS:
-h, --help Print help information
SUBCOMMANDS:
build Combile markdown into HTML
help Print this message or the help of the given subcommand(s)
new Start new book
```
# Coming soon
1. Light/Dark theme
2. Sub-chapters
3. Toggle sidebar
4. Copy code snippet
5. **Proper error hanlding & error message**
# Output example
