Skip to content

NeedCoolerShoes/wiki

Repository files navigation


Logo

NeedCoolerShoes Wiki

Report Bug - Request Feature

About The Project

The NeedCoolerShoes wiki made using Mkdocs with Mkdocs Material

Built With

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

Installation

  1. Clone the repo
    git clone https://github.com/NeedCoolerShoes/wiki.git
  2. Activate the virtual enviroement
  3. Install dependencies
    poetry install
  4. Start the Mkdocs webserver
    mkdocs serve

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the CC BY-SA 4.0 License. See CC BY-SA 4.0 License for more information.

Contact

The NeedCoolerShoes Team - @needcoolershoes.com - dev @ needcoolershoes.com

Project Link: GitHub

Releases

No releases published

Sponsor this project

Packages

No packages published

Contributors 5

Languages