Skip to content

Felitendo/Docs

Repository files navigation

Willkommen bei Felo Docs. Hier kannst du die Seiten bearbeiten und ein Pull Request erstellen, damit ich deine Änderungen implementieren kann. Hier ein kleines Tutorial:

  1. Lade dir Github Desktop hier herunter.
  2. Lade dir Visual Studio Code hier herunter.
  3. Lade dir Node.js hier herunter.
  4. Lade dir Git hier herunter.
  5. Öffne Github Desktop und melde dich mit deinem Github Account an.
  6. Klicke auf "File -> Clone Repository" und Klicke auf "URL". Gib dort "https://github.com/Felitendo/Docs" ein.
  7. Klicke auf "clone" und warte bis es fertig mit clonen ist.
  8. Klicke auf "Open in VSCode"
  9. Klicke auf "Terminal -> new Terminal" und gib dort "npm i" ein.
  10. Warte bis alles installiert ist und gib dann "npm i react-player" ein.
  11. Gib dann entweder "npm start" oder "node ./index.js" ein.
  12. Öffne diese Website in deinem Browser: http://localhost:25561
  13. Ändere die Seite die du ändern willst. Die Docs findest du in "/docs/".
  14. Speichere deine Änderungen mit STRG + S
  15. Gehe wieder in Github Desktop und klicke auf "Commit to main" oder "Open pull request".
  16. Beschreibe was genau du geändert hast und schicke deine Pull Request ab.
  17. Warte, bis deine Pull Request bearbeitet wurde. Dies sollte normalerweise nicht länger als 3 Tage dauern. Wenn doch, kannst du mir gerne auf Discord schreiben (@felitendo).

Von Docusaurus:

Website

This website is built using Docusaurus, a modern static website generator.

Installation

$ yarn

Local Development

$ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.