GitHunt

Introduction

Converts Markdown files to HTML pages. It uses Bulma CSS library. It uses the showdownjs 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/

Languages

JavaScript83.9%HTML16.1%

Contributors

MIT License
Created July 7, 2021
Updated August 9, 2021
cemalgnlts/buldoc | GitHunt