https://github.com/ruanyf/loppo

an extremely easy static site generator of markdown documents
https://github.com/ruanyf/loppo

Last synced: 1 day ago
JSON representation

an extremely easy static site generator of markdown documents

• Host: GitHub
• URL: https://github.com/ruanyf/loppo
• Owner: ruanyf
• Created: 2016-12-14T04:47:49.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2023-12-14T06:33:19.000Z (11 months ago)
• Last Synced: 2024-11-01T13:35:56.221Z (12 days ago)
• Language: JavaScript
• Homepage:
• Size: 523 KB
• Stars: 738
• Watchers: 43
• Forks: 108
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Loppo is an extremely easy static site generator of markdown documents. You get your site with only one command. Please visit [demo](http://redux.ruanyifeng.com/).

## Features

- easy config ([example](https://raw.githubusercontent.com/ruanyf/loppo/master/loppo.yml.default))

- simple site structure ([example](https://raw.githubusercontent.com/ruanyf/redux-docs/master/chapters.yml))

- friendly template syntax([example](https://raw.githubusercontent.com/ruanyf/redux-docs/master/themes/oceandeep/page.template))

- built-in [utility commands](docs/sub-commands.md)

## How to use

**Attention: Loppo is still in its very early stages. Use it in production at your own risk.**

First of all, arrange your documents into the following structure.

```

|- myProject

   |- README.md

   |- docs

      |- page1.md

      |- page2.md

      |- ...

```

Now, install Loppo.

```bash

$ npm install loppo -g

```

Enter your project directory.

```bash

$ cd myProject

```

Run the command.

```bash

$ loppo

```

Now, Loppo will build the document site under `dist` sub-directory. After the building process, you could open the site in your browser.

```bash

$ open dist/index.html

```

## License

GPL v3