Total Pageviews

Tuesday 27 October 2015

静态wiki站点生成器-MinoriWiki

MinoriWiki is a static Wiki site Generator .
MinoriWiki is a static Wiki site Generator npm version
Currently under development - PRs welcome

Usage

  1. Install via NPM: npm install minori -g
  2. Create an empty directory
  3. minori init
  4. Edit config.yml to fit your needs
  5. Use minori note [filename] to create new note or edit existing one, you can also use api/data for filename to create directories
  6. Deploy your files generated under site directory (Default to wiki) to production environment with command minori commit.
  • source (defaults to notes) directory contains all note markdown files
  • static (defaults to static) directory will be copied to site directory, you could store any static files that may be used in your wiki site.
  • site (defaults to wiki) directory contains generated site files.
If you are going to change the site directory, just rename the wiki folder to keep Git objects.

Commands

  • minori init or minori i - Init under current working directory
  • minori note [filename] or minori n [filename] - Create or edit note
  • minori done or minori d - Generate site files
  • minori commit or minori c - Commit changes and deploy to production environment

Theme

Theme is customizable. Theme directory should contain:
  • assets directory to store style sheets, scripts, fonts, etc.
  • index.ejs is the homepage template.
  • page.ejs is the post page template.
The following variables are passed to EJS:
  • config - the parsed config.yml object
  • categories - Array of category object:
[
    {
        "name": "uncategoried",
        "pages": [
            {
                "title": "page title",
                "link": "page-file-name",
                "category": "uncategoried",
                "content": "parsed html"
            },
            ...
        ]
    },
    ...
]
  • page - {} in homepage and the specified page object in post page。
from https://github.com/phoenixlzx/MinoriWiki