Skip to content

SotaWatanabe/polkadot-wiki

 
 

Repository files navigation

Documentation Status

Polkadot Wiki

This repository contains the source files for the Polkadot wiki.

Running locally

Clone the repository to your local file system.

git clone https://github.com/w3f/Polkadot-wiki.git

Install mkdocs by using the pip package manager.

pip install mkdocs --user

Run mkdocs serve from the repository root to spawn a hot reloading development server and navigate to localhost:8000 in a web browser.

Publishing

The wiki is hosted on Read the Docs and is built on each published commit to the master branch on the GitHub repository.

Styling

Mkdocs-Material is used to give the wiki its sleek theme.

Contributing

Please read over the rules for contribution at the CONTRIBUTING document.

If you add a page please ensure that you give it the correct placement in the navigation by manually inputting it in the mkdocs.yml under the nav field. It is done in this way in order to have more control in how pages are displayed on the UI and give better organization to topics.

About

The Polkadot wiki.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 39.2%
  • CSS 34.3%
  • JavaScript 23.9%
  • Shell 1.1%
  • Makefile 0.6%
  • Python 0.5%
  • Dockerfile 0.4%