Git Product home page Git Product logo

website's Introduction

OpenPotato Website

This is the website for OpenPotato, the home of our Open Data projects. It's Open Source and we have implemented it using MkDocs and Material for MkDocs.

Install MkDocs for Windows

  1. Install Python. Go to the Python downloads page and download the latest version for Windows.

  2. Launch the installer and follow the on-screen instructions.

  3. Run the command prompt as Administrator.

  4. Enter the command python --version and pip --version to check the Python installation. In both cases a version number should appear as an output in the command prompt.

  5. Enter the command pip install mkdocs mkdocs-material mkdocs-minify-plugin to install the MkDocs Python package, the Material for MkDocs theme and the MkDocs plugin Minify.

  6. Final test: Enter the command mkdocs --version. A version nummer in the command prompt will let you know if everything has been installed correctly.

Clone Repository

This repository is a Git repository. To clone the repository to a local commputer you will need a Git client. Either install Git for Windows and use the command prompt or install one of the many GUIs. We recommend GitHub Desktop or SourceTree.

  1. Create a local directory for the documentation e.g. c:\openpotato.

  2. Open the command prompt and change to directory c:\openpotato.

  3. Enter the command git clone https://github.com/openpotato/website.git to clone the repository.

Using MkDocs

You have installed Python and MkDocs and cloned the repository. Now you can generate the documentation locally on your computer.

  1. Start the command prompt and change to the directory c:\openpotato\de for German documentation or c:\openpotato\en for the English documentation.

  2. Enter the command mkdocs build. The documentation will be regenerated.

  3. To display the result, enter the command mkdocs serve and open the URL http://127.0.0.1:8000 in your Web browser.

The table of contents can be found in the mkdocs.yml file and the individual chapters are in the docs subdirectory.

Can I help?

Yes, that would be much appreciated. The best way to help is to post a response via the Issue Tracker and/or submit corrections via a Pull Request.

website's People

Contributors

fstueber avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.