https://github.com/cemalgnlts/buldoc
Bulma style document generator.
https://github.com/cemalgnlts/buldoc
bulma-css bulma-ui document-generation documentation markdown-documentation
Last synced: about 2 months ago
JSON representation
Bulma style document generator.
- Host: GitHub
- URL: https://github.com/cemalgnlts/buldoc
- Owner: cemalgnlts
- License: mit
- Created: 2021-07-07T20:17:38.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2021-08-09T10:21:25.000Z (over 3 years ago)
- Last Synced: 2025-01-14T07:48:30.017Z (3 months ago)
- Topics: bulma-css, bulma-ui, document-generation, documentation, markdown-documentation
- Language: JavaScript
- Homepage: https://csb-81r2k.vercel.app/
- Size: 25.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Introduction
Converts Markdown files to HTML pages. It uses [Bulma](https://github.com/jgthms/bulma) CSS library. It uses the [showdownjs](https://github.com/showdownjs/showdown) library to convert the markdown file to HTML code.
# Setup
1. Download project: `git clone https://github.com/cemalgnlts/buldoc.git && cd buldoc`
2. Install: `npm install -g .`
# Usage
To create a new document:
```
buldoc new [name]
```
Use the build command to create HTML pages.
```
buldoc build
```
Create a project called Flowers. The project will be created in the directory you are in. `buldoc new flowers`
Result:
```
flowers/
├─ docs/
│ ├─ index.md
├─ static/
```
Documents should be added to the **docs** folder.
To generate the HTML pages, in the home directory *( ./flowers or ./flowers/docs )*
run: `buldoc build`
HTML pages are added to the **static** folder.
Result:
```
flowers/
├─ docs/
│ ├─ index.md
├─ static/
│ ├─ index.html
```
# Online Editor
With the Online Editor, you can quickly create and download a document. Preview does not support code highlighting. After downloading the code highlighting will work.
https://csb-81r2k.vercel.app/