项目作者: Waikato

项目描述 :
Home of the Weka wiki.
高级语言: HTML
项目地址: git://github.com/Waikato/weka-wiki.git
创建时间: 2018-06-11T21:34:25Z
项目社区:https://github.com/Waikato/weka-wiki

开源协议:

下载


Weka Wiki

Not really a wiki, but replacing some of the content that was hosted on
weka.wikispaces.com before it shut down. Uses mkdocs
to generate the content.

The wiki can be found at this location:

https://waikato.github.io/weka-wiki/

Installation

mkdocs works with Python 2.7 and 3.x.

Best approach is to install mkdocs (>= 0.16.0) in a virtual environment
(venv directory):

  • Python 2.7

    1. virtualenv -p /usr/bin/python2.7 venv
  • Python 3.6 (Python 3.5 works as well)

    1. virtualenv -p /usr/bin/python3.6 venv
  • Install the mkdocs package

    1. ./venv/bin/pip install mkdocs==1.4.2 jinja2==3.1.2 "Markdown<3.4.0" mkdocs-material==8.5.10

Content

In order for content to show up, it needs to be added to the configuration,
i.e., in the pages section of the mkdocs.yml file.

Some pointers:

Build

mkdocs is used to generate HTML from the
markdown documents and images:

  1. ./venv/bin/mkdocs build --clean

Testing

You can test what the site looks like, using the following command
and opening a browser on localhost:8000:

mkdocs monitors setup and markdown files, so you can just add and edit
them as you like, it will automatically rebuild and refresh the browser.

  1. ./venv/bin/mkdocs build --clean && ./venv/bin/mkdocs serve

Deploying

You can deploy the current state to Github pages with the following command:

  1. ./venv/bin/mkdocs gh-deploy --clean