Cowadar Personal Knowledge Management

Cowadar

Personal Knowledge Management

Fout melden . Feature aanvragen

Inhoudsopgave

• Cowadar Personal Knowledge Management
  • Inhoudsopgave
  • Over Cowadar
  • Gemaakt met
  • Aan de slag
    • Vereisten
    • Installatie
  • Gebruik
  • Roadmap
  • Contributing
    • Creating A Pull Request
  • License
  • Authors

Over Cowadar

We hebben deze PKM opgezet aangezien we beide dagelijks veel bijleren en er dagelijks nieuwe technologiëen en ontwikkelingen ontstaan. Aangezien we het fijn vinden om mee te zijn met de laatste nieuwtjes, hebben we uiteraard ook een plaats nodig om dit te kunnen documenteren.

Hoe is deze PKM ontstaan? In het begin hebben we op Discord veel nuttige informatie "📌 gepind" in onze gezamelijke chat. Deze chat is heilig voor ons en hebben al vaak gesproken over wat een ramp het zou zijn als deze chat ooit verwijderd zou worden.

Uiteraard is een chat niet overzichtelijk en moeten we toch vaak beroep doen op de zoekfunctie.

Daarom heeft Bedar voorgesteld om te werken met mkdocs.

Gemaakt met

• ♥️
• Material for MkDocs

Aan de slag

Onze website bestaat uit 2 repositories:

• cowadar/cowadar
• cowadar/pkm

Volg deze eenvoudige stappen om een lokale kopie aan de gang te krijgen.

Vereisten

Zorg voor je begint dat je deze packages hebt geinstalleerd:

• git

sudo apt install git

• python

sudo apt install -y python3-pip

Installatie

1. Clone de repo

git clone https://github.com/cowadar/pkm.git

2. Navigeer naar de folder

cd cowadar

3. Installeer de repo requirements

pip install -r requirements

Gebruik

MkDocs bevat een live preview-server, zodat u uw wijzigingen kunt bekijken terwijl u uw documentatie schrijft. De server zal de site na het opslaan automatisch opnieuw opbouwen. Begin het met:

mkdocs serve

Om de projectdocumentatie handmatig te implementeren, kunt u gewoon de volgende opdracht gebruiken vanuit de map met het bestand mkdocs.yml:

mkdocs gh-deploy --force

Roadmap

Zie de open issues voor een lijst met voorgestelde features (en gekende issues).

Contributing

Bijdragen maken de open source-community zo'n geweldige plek om te leren, te inspireren en te creëren. Elke bijdrage die u levert wordt zeer op prijs gesteld.

• Als je suggesties hebt voor het toevoegen of verwijderen van projecten, open dan gerust een probleem om het te bespreken, of maak direct een pull-aanvraag nadat je het README.md-bestand met de nodige wijzigingen hebt bewerkt.
• Zorg ervoor dat je je spelling en grammatica controleert.
• Creëer individuele PR voor elke suggestie.

Creating A Pull Request

1. Fork the Project
2. Creëer je Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit je aanpassingen (git commit -m 'Add some AmazingFeature')
4. Push naar de Branch (git push origin feature/AmazingFeature)
5. Open een Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Authors

• Bedar - Homelab freak - Bedar - Repo & website maintainer
• Cowarol - Netwerk zot - Cowarol - Schrijver