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

Home of the Weka wiki.
https://github.com/waikato/weka-wiki

mkdocs weka wiki

Last synced: 6 days ago
JSON representation

Home of the Weka wiki.

• Host: GitHub
• URL: https://github.com/waikato/weka-wiki
• Owner: Waikato
• Created: 2018-06-11T21:34:25.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-12-19T20:51:33.000Z (14 days ago)
• Last Synced: 2024-12-21T16:07:23.273Z (13 days ago)
• Topics: mkdocs, weka, wiki
• Language: HTML
• Homepage: https://waikato.github.io/weka-wiki/
• Size: 26.5 MB
• Stars: 77
• Watchers: 6
• Forks: 68
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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](http://www.mkdocs.org/) 

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

  ```

  virtualenv -p /usr/bin/python2.7 venv

  ```

* Python 3.6 (Python 3.5 works as well)

  ```

  virtualenv -p /usr/bin/python3.6 venv

  ```

* Install the mkdocs package

  ```

  ./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:

* [Images and media](http://www.mkdocs.org/user-guide/writing-your-docs/#images-and-media)

* [Linking](http://www.mkdocs.org/user-guide/writing-your-docs/#linking-documents)

* [mkdocs.yml](http://www.mkdocs.org/user-guide/configuration/)

## Build

[mkdocs](http://www.mkdocs.org/) is used to generate HTML from the 

markdown documents and images:

```

./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](http://127.0.0.1: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.

```

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

```

## Deploying

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

```

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

```