Skip to content
Snippets Groups Projects
Select Git revision
  • documentation/global-header-file-setup
  • main default protected
  • fix/missing-API-documentation-for-python-modules
  • fix/delete_mingw
  • feature/new_systems_methodology
  • fix/missing-api-documentation
  • feature/python_example_folder_update
  • beta_release protected
  • fix/revert-gitlab-config
  • fix/citationEcologicalAssessment
  • documentation/styleupdate
  • feature/lightMode
  • documentation/create_mission_xml
  • 28-empennage-design-update-documentation-according-to-workshop
  • documentation/fix-dot-equations
  • documentation/propulsion-design-module
  • documentation/gitlab-workflow
  • documentation/cost_estimation_update
  • documentation/mkdocs_python_update
  • documentation/tank_design_update
  • documentation/landing_gear_design_update
  • 0.5.0
22 results

unicado.gitlab.io

  • Open with
  • Download source code
  • Alfin Johny's avatar
    Alfin Johny authored
    In the previously built UNICADO website, many pages had inconsistent
    headers. This commit aims to address the issue by leveraging mkdoxy
    documentation. Initially, only propulsion_design-related files have been
    modified to test this approach. If successful, the solution can be
    extended to all other subpages to resolve the header inconsistency
    problem.
    Issue: #22
    c56458b3
    History

    Unicado Pages

    This repository contains the static website of UNICADO which is hosted by GitLab pages. We are using mkdocs as the static site generator to generate the website from markdown files.

    Preview

    It is assumed you have a working 🐍 Python installation in the following!

    You can preview the website after cloning it. First you need to install mkdocs and the used theme by:

    pip install mkdocs mkdocs-material mkdocs-glightbox

    Then you can change the directory to the repository and run

    mkdocs serve

    This will start a local webserver which you can access with your webbrowser and preview the website.

    with pipenv

    You can also start the server inside a virtual environment using pipenv:

    pipenv run mkdocs serve

    Further Documentation

    For features of the site generator and its theme please refer to their excellent documentation:

    Page Template

    The pages are written in plain markdown. The site generator has the option the extract some meta data from the content. A template might look like this:

    ---
    title: Displayed Title of Page
    summary: Summary of the page content.
    authors:
        - Author 1
        - Author 2
    date: yyyy-mm-dd
    ---
    # MyPage
    
    <Content goes here>