Clone repository
git clone https://github.com/EdwinWalela/tiwi
Run tests and compile tiwi
cd tiwi && make
Run tiwi
./tiwi
tiwi parses and builds html sites from markdown
Usage:
tiwi [command]
Available Commands:
build Generates HTML files
create Initializes the tiwi project
help Help about any command
Flags:
-h, --help help for tiwi
Use "tiwi [command] --help" for more information about a command.
$ ./tiwi create
The create
command takes in an argument of the project name.
Please specify the project name:
tiwi create <my-project>
For example:
tiwi create my-tiwi-site
./tiwi create my-site
The create
command scaffolds the project with the following default markdown files:
- index.md
- not-found.md
- first-article.md
- getting started.md
./tiwi build -w <project-name>
This commands generates a folder called static
containing the HTML files
The build
command takes in an optional flag -w
which converts empty lines to <br/>
tags
$ ./tiwi build my-site
Found [4] page(s):
- first-article.md
- getting-started.md
- index.md
- not-found.md
Generating HTML...
Process complete. HTML files generated at mysite/static.
Any contribution, in the form of a suggestion, bug report or pull request, is well accepted.
Here is a list of good issues to get started