Skip to main content

docusaurus

├── blog
├── build
    ├── 404.html
    ...
├── docs
    ├── Benutzer
    ...

├── node_modules
├── src
    ├── css
        └── custom.css
    └── pages
        ├── index.js
        ├── markdown-page.md
        └── styles.module.css

├── Startseite (Kopie).md
├── static
    ├── api
    └── img

├── babel.config.js
├── docusaurus.config.js
├── package.json
├── package-lock.json
├── README.md
└──  sidebars.js

Unterverzeichnisse​

  • /blog/ Das Blog-Feature wird von uns nicht verwendet.
  • /build/ Beinhaltet den fertigen Build, der durch den Befehl npm run build erstellt wird.
  • /docs/ Docusaurus ist ein Webseiten-Generator. Der gewünschte Inhalt muss in Markdown-Datein (.md) oder Markdown-Dateien inkl. React Komponenten (.mdx) geschrieben und hier gespeichert werden.
  • /node_modules/ In diesem Verzeichnis befinden sich die installierten nodejs Pakete.
  • /src/ Beinhaltet Unterordner mit relevanten CSS und JS Dateien.
  • /static/api Neben der Docusaurus-api befindet sich der Teil der Documentation in dem Ordner der mit js-doc erstellt wurde.
  • /static/img Docusaurus erwartet Bild- und Videodateien in diesem Ordner.

Dateien​

  • /src/css/custom.css Ist die Standart CSS-Datei von Docusaurus. Beinhaltet den gesamten leicht veränderten Inhalt von node_modules/font-awesome/css/font-awesome.min.css, da die Einbindung von FontAwesome sonst nicht funktioniert.   Einbindung von CSS-Dateien in Docusaurus
  • src/pages/index.js Hier kann die Startseite gestaltet werden.
  • src/pages/styles.module.css Grundsätzlich wird das Aussehen von Docusaurus über Presets festgelegt. Reichen einem diese nicht aus, gibt es hier weitere Gestaltungsmöglichkeiten. Ist standartmäßig eingebunden in docusaurus.config.js.
  • babel.config.js Babel ist ein Javascript-Compiler. Es wird die standartmäßige Docusaurus-Konfiguration verwendet.
  • docusaurus.config.js Enthält die Konfiguration der Templates.
  • package.json Definiert das git-reposetory sowie die dev-dependencies der Pakete. Letzteres stellt sicher, dass die gewünschten Versionen instaliert werden, wenn npm-install ausgeführt wird´.   Zusätzliche Information
  • /package-lock.json Wird automatisch erstellt und beschreibt den dependency-tree.   Zusätzliche Information
  • sidebars.js Hier werden die Sidebars für Entwickler und Benutzer spezifiziert.