Skip to content
Snippets Groups Projects
Commit ff377b0e authored by Kristina Mazur's avatar Kristina Mazur
Browse files

Add comments in mkdocs, new format with navigation panels, standardized css and new index.md

parent c4a9fc7e
No related branches found
No related tags found
3 merge requests!76Draft: Updated Python code example,!73Initial open source version,!4New layout
Hide whitespace changes
Inline Side-by-side
docs/assets/css/unicado.css
+ 101
− 17
View file @ ff377b0e
/* Define color variables in :root for easy reference */
:root {
--primary-color: #2C3E50; /* Primary color for headers, hero section, and cards */
--background-color: #34495E; /* Background color for main content areas */
--text-color: #D1D5DB; /* Main text color for readability on dark backgrounds */
--button-bg-color: #ffffff; /* Background color for buttons */
--accent-color: #E74C3C; /* Accent color for links and hover effects */
--secondary-accent: #1ABC9C; /* Secondary accent color for icons */
--link-color: #3498DB; /* Link color for clickable items */
--link-hover-color: #E74C3C; /* Hover color for links */
}
.md-header {
background-color: var(--primary-color);
}
/* Apply primary color to tab backgrounds */
[data-md-color-scheme=slate] .md-tabs {
background-color: var(--primary-color);
}
/* Hero Section Styling */
.hero-section {
background-color: var(--primary-color);
padding: 2em;
border-radius: 10px;
box-shadow: 0 4px 8px rgba(0, 0, 0, 0.2);
max-width: 900px;
margin: auto;
}
/* Text styling within the hero section */
.intro-text {
color: var(--text-color);
font-size: 1.1em;
}
/* Download button styling */
.download-button-container {
text-align: center;
margin-top: 20px;
}
.download-button {
display: inline-block;
background-color: var(--button-bg-color); /* Uses button background color */
padding: 10px 20px;
font-size: 1.1em;
font-weight: bold;
border-radius: 5px;
text-decoration: none;
color: var(--primary-color); /* Button text color */
transition: background-color 0.3s ease;
}
/* Grid Container */
.grid-container {
grid-gap: .4rem;
display: grid;
grid-template-columns: repeat(auto-fit,minmax(16rem,1fr));
margin: 1em 0;
grid-template-columns: repeat(auto-fit, minmax(220px, 1fr));
gap: 1.5em;
margin: 2em auto;
max-width: 1100px;
padding: 1em;
}
.grid-item {
border: .05rem solid var(--md-default-fg-color--lightest);
border-radius: .1rem;
display: block;
margin: 0;
padding: .8rem;
transition: border .25s,box-shadow .25s;
background-color: var(--primary-color); /* Uses primary color for card background */
padding: 1.5em;
border-radius: 10px;
text-align: left;
color: var(--text-color); /* Text color for readability */
transition: transform 0.3s, box-shadow 0.3s;
}
.grid-item h3 {
font-size: 1.25em;
margin-bottom: 0.5em;
}
/* Card styling with hover effects */
.card {
box-shadow: 0 4px 8px rgba(0, 0, 0, 0.15);
border: 1px solid rgba(255, 255, 255, 0.1);
}
.grid-item:where(:hover, :focus) {
border-color: #0000;
box-shadow: var(--md-shadow-z2);
.card:hover {
transform: translateY(-5px);
box-shadow: 0 8px 16px rgba(0, 0, 0, 0.25);
}
.overview-item {
min-height: 240px;
/* Link styling within cards */
.card a {
color: var(--link-color);
font-weight: bold;
}
.overview-img {
width: 200px;
}
\ No newline at end of file
.card a:hover {
color: var(--link-hover-color); /* Changes to accent color on hover */
}
/* Accent color for icons or specific elements */
.accent {
color: var(--secondary-accent); /* Teal accent color for specific elements */
}
/* Footer Image Styling */
.footer-image img {
width: 200px;
border-radius: 8px;
box-shadow: 0 4px 8px rgba(0, 0, 0, 0.15);
margin-top: 1em;
}
docs/index.md
+ 37
− 27
View file @ ff377b0e
......@@ -3,60 +3,70 @@ title: Welcome to UNICADO
summary: Home page of the UNICADO project
authors:
- Sebastian Oberschwendtner
date: 2023-09-08
- Kristina Mazur
date: 2024-10-26
glightbox: false
hide:
- navigation
- toc
---
![banner](assets/images/logos/unicado.png)
# Welcome to UNICADO
**UNICADO** is a preliminary aircraft design tools which groups many design modules.
Go through the following stuff to get an idea what **UNICADO** is and how it works:
<div class="hero-section" markdown="1">
![banner](assets/images/logos/unicado.png){.hero-logo}
# Think. Design. Change.
<div class="grid-container" markdown="1">
<div class="grid-item" markdown="1">
<div class="intro-text" markdown="1">
**UNICADO** is a conceptual aircraft design environment that provides a robust framework for designing, analyzing, and optimizing both conventional and unconventional aircraft based on a minimum set of requirements. Developed in collaboration with leading German aerospace universities, it enables designers to define an aircraft's geometry, size, performance, or feasibility while balancing aerodynamic, operational, and user-specific requirements. Its modular architecture allows for easy customization and adaptability, enabling users to integrate new tools or methods.
</div>
<div class="download-button-container">
<a href="link-to-download" class="download-button">Download UNICADO</a>
</div>
</div>
:material-clock-fast:{ .lg .middle } **Getting Started**
## Explore UNICADO
<div class="grid-container" markdown="1">
<div class="grid-item card" markdown="1">
:material-clock-fast:{ .lg .accent } **Getting Started**
---
Learn how to set it up and install the required prerequisites.
Learn how to set it up, install the required prerequisites, and design your first aircraft.
[:octicons-arrow-right-24: Getting Started](getting-started/installation.md)
</div>
<div class="grid-item" markdown="1">
:fontawesome-solid-plane-departure:{ .lg .middle } **Cleared for Take Off**
<div class="grid-item card" markdown="1">
:material-library:{ .lg .accent } **Available Tools**
---
Start designing aircraft to your requirements.
[:octicons-arrow-right-24: Start Designing](getting-started/takeoff.md)
Get an overview of the tools and components available within **UNICADO**.
[:octicons-arrow-right-24: Module Overview](modules/overview.md)
</div>
<div class="grid-item" markdown="1">
:material-library:{ .lg .middle } **Available Tools**
---
<div class="grid-item card" markdown="1">
:fontawesome-solid-plane-departure:{ .lg .accent } **Cleared for Developing**
Get an overview which tools and components are available within **UNICADO**.
---
[:octicons-arrow-right-24: Module Overview](modules/overview.md)
Get insights on how to contribute and develop.
[:octicons-arrow-right-24: Start Designing](developer/contribute.md)
</div>
<div class="grid-item" markdown="1">
:material-scale-balance:{ .lg .middle } **Open Source**
<div class="grid-item card" markdown="1">
:material-scale-balance:{ .lg .accent } **Open Source**
---
**UNICADO** is available as open source software licensed under **GPLv3**.
**UNICADO** is available as open-source software licensed under **GPLv3**.
[:octicons-arrow-right-24: License](license.md)
</div>
</div>
</div>
![](assets/images/logos/bmwk.png){width="400"}
\ No newline at end of file
<div class="footer-image" markdown="1">
![](assets/images/logos/bmwk.png){width="200"}
</div>
mkdocs.yml
+ 97
− 101
View file @ ff377b0e
......@@ -15,122 +15,118 @@
# along with this program. If not, see <https://www.gnu.org/licenses/>.
# === General site meta data ===
site_name: UNICADO
repo_url: https://git.rwth-aachen.de/unicado/unicado-package
repo_name: Unicado Repository
site_name: UNICADO # The name of the site, displayed in the header.
repo_url: https://git.rwth-aachen.de/unicado/unicado-package # Link to the Git repository, will appear in the header.
repo_name: UNICADO Repository # Name for the Git repository link in the header.
# === Site configuration ===
markdown_extensions:
- attr_list
- admonition
- md_in_html
- toc:
permalink: '#'
- pymdownx.tabbed:
alternate_style: true
- pymdownx.emoji:
- attr_list # Allows adding HTML attributes to Markdown elements (like classes).
- admonition # Enables note/warning/admonition boxes with custom styling.
- md_in_html # Allows writing Markdown inside HTML tags for flexibility.
- toc: # Adds a table of contents (ToC) for each page.
permalink: '#' # Adds a clickable '#' for each ToC heading, allowing direct links.
- pymdownx.tabbed: # Enables tabbed content blocks, allowing content to be organized in tabs.
alternate_style: true # Uses an alternate style for tabbed blocks.
- pymdownx.emoji: # Adds support for emojis using the Material theme’s emoji set.
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.details
- pymdownx.superfences
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.critic
- pymdownx.caret
- pymdownx.keys
- pymdownx.mark
- pymdownx.tilde
- pymdownx.highlight: # Adds code syntax highlighting with custom line anchors.
anchor_linenums: true # Makes line numbers clickable in code blocks.
line_spans: __span # Adds spans around lines for custom styling.
pygments_lang_class: true # Adds language class to highlighted code for styling consistency.
- pymdownx.details # Enables collapsible details/summary blocks for content hiding/showing.
- pymdownx.superfences # Adds advanced fence syntax for blocks like code or tabs.
- pymdownx.inlinehilite # Allows inline code highlighting within text.
- pymdownx.snippets # Enables code snippets for reusing code blocks across pages.
- pymdownx.critic # Adds Critic Markup support for collaborative editing.
- pymdownx.caret # Adds support for superscript text with a caret.
- pymdownx.keys # Adds special styling for keyboard key indicators.
- pymdownx.mark # Adds highlighting functionality for text.
- pymdownx.tilde # Enables strikethrough formatting.
# Additional JavaScript files to include for rendering mathematical notation
extra_javascript:
- assets/javascripts/katex.js
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.js
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/contrib/auto-render.min.js
- assets/javascripts/katex.js # Local KaTeX script.
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.js # CDN KaTeX script (same as local but hosted externally).
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/contrib/auto-render.min.js # KaTeX auto-render script (converts Latex syntax in formatted math).
# Additional CSS files to include for styling of website and mathematical notations (font, size etc.)
extra_css:
- assets/css/unicado.css
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.css
- assets/css/unicado.css # Custom CSS for styling the UNICADO site.
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.css # CSS for KaTeX math rendering.
# === Plugins ===
plugins:
- glightbox
- glightbox # Plugin for lightbox-style image and content viewing.
# === Theme configuration ===
theme:
name: material
favicon: assets/favicon.png
logo: assets/images/logos/unicado-icon.png
name: material # Specifies the theme name (alternatives: material, mkdocs, readthedocs).
favicon: assets/favicon.png # Path to the favicon image displayed in the browser tab (same as logo).
logo: assets/images/logos/unicado-icon.png # Path to the UNICADO logo displayed in the header.
# Theme colors configuration
palette:
scheme: slate
primary: blue grey
accent: lime
scheme: slate # Sets a dark theme style.
primary: blue grey # Main color of the theme (used for buttons, links, etc.).
accent: red # Accent color for highlights.
# Feature configurations for navigation and ToC behavior
features:
- navigation.path
- navigation.top
- navigation.tabs
- toc.follow
- navigation.instant # Enables instant navigation between pages (no reload).
- navigation.tabs # Adds navigation tabs for each main section in `nav`.
- navigation.path # Shows the navigation path/breadcrumbs.
- toc.follow # Highlights the current section in the ToC as you scroll.
- navigation.footer # Adds navigation links in the footer.
# Additional links (social) to display in the header
extra:
social:
- icon: fontawesome/brands/github # Icon for the GitHub link (uses FontAwesome icon set).
link: https://git.rwth-aachen.de/unicado/unicado-package # URL for the Git repository.
name: "Unicado Repository" # Name displayed when hovering over the repository icon.
# === Navigation Menu ===
nav: # Customizes the main navigation structure of the site.
- Home: 'index.md' # Main page of the site.
- Download: # Top-level navigation item for "Download".
- Installation: 'getting-started/installation.md' # Link to the installation page.
- Cleared for Take-Off: 'getting-started/takeoff.md' # Link to the takeoff/getting started page.
- Documentation: # Top-level item for documentation.
- Overview: 'modules/overview.md' # Overview of modules.
- Aircraft Design: # Subsection for Aircraft Design.
- 'modules/sizing.md' # Link to sizing module page.
- 'modules/analysis.md' # Link to analysis module page.
- Libraries: 'modules/libraries.md' # Link to libraries overview.
- Utilities: 'modules/additional-software.md' # Link to additional software page.
- Workflow: 'workflow.md' # Link to the workflow page.
- Get involved: # Top-level item for contributions and development.
- How to Contribute: # Subsection for contribution guidelines.
- Basics: 'developer/contribute.md'
- Merge Requests: 'developer/merge-request.md'
- Review Merge Requests: 'developer/review-merge-request.md'
- Build Instructions:
- Prerequisites:
- Windows: 'developer/build-environment/windows.md'
- Linux: 'developer/build-environment/linux.md'
- MacOS: 'developer/build-environment/macos.md'
- MSYS2/MinGW (deprecated): 'developer/build-environment/mingw.md'
- Get Source Code: 'developer/get-source-code.md'
- Build:
- C++: 'developer/build/cpp.md'
- Python: 'developer/build/python.md'
- Include libraries: 'developer/including-libraries.md'
- CMake Presets: 'developer/cmake-presets.md'
- Testing Guidelines: 'developer/testing.md'
- Release Package: 'developer/release-package.md'
- Style Guide:
- C++: 'developer/style/cpp.md'
- Python: 'developer/style/python.md'
- IDE Setup: 'developer/ide-setup.md'
# === Page Tree ===
nav:
- 'Home':
- 'index.md'
- 'description.md'
- 'workflow.md'
- 'partners.md'
- 'Module Overview':
- 'modules/overview.md'
- 'Aircraft Design':
- 'modules/sizing.md'
- 'modules/analysis.md'
- 'modules/libraries.md'
- 'modules/additional-software.md'
- 'Getting Started':
- 'getting-started/installation.md'
- 'getting-started/takeoff.md'
- 'Developer':
- 'How to Contribute':
- 'Basics': 'developer/contribute.md'
- 'How to create a merge request' : 'developer/merge-request.md'
- 'How to review a merge request' : 'developer/review-merge-request.md'
- 'Build Instructions':
- 'Prerequisites':
- 'Windows': 'developer/build-environment/windows.md'
- 'Linux': 'developer/build-environment/linux.md'
- 'MacOS': 'developer/build-environment/macos.md'
- 'MSYS2/MinGW (deprecated)': 'developer/build-environment/mingw.md'
- 'Get Source Code': 'developer/get-source-code.md'
- 'Build':
- 'C++': 'developer/build/cpp.md'
- 'Python': 'developer/build/python.md'
- 'Libraries': 'developer/including-libraries.md'
- 'CMake Presets': 'developer/cmake-presets.md'
- 'Testing Guidelines': 'developer/testing.md'
- 'Release Package/Installer': 'developer/release-package.md'
- 'Style Guide':
- 'C++': 'developer/style/cpp.md'
- 'Python': 'developer/style/python.md'
- 'IDE Setup': 'developer/ide-setup.md'
# - 'Aircraft Exchange File':
# - 'General': 'aircraft-xml/general.md'
# - 'MassesAndLoadings': 'aircraft-xml/masses.md'
# - 'Geometry': 'aircraft-xml/geometry.md'
# - 'Structure': 'aircraft-xml/structure.md'
# - 'Accommodation': 'aircraft-xml/accommodation.md'
# - 'Propulsion': 'aircraft-xml/propulsion.md'
# - 'Systems': 'aircraft-xml/systems.md'
# - 'Aerodynamics': 'aircraft-xml/aerodynamics.md'
# - 'StabilityAndControlCharacteristics': 'aircraft-xml/stability.md'
# - 'Performance': 'aircraft-xml/performance.md'
# - 'MonetaryValues': 'aircraft-xml/monetary.md'
# - 'EcologicalValues': 'aircraft-xml/ecological.md'
# - 'Requirements': 'aircraft-xml/requirements.md'
# - 'DesignSpecification': 'aircraft-xml/specification.md'
- 'About':
- 'license.md'
- 'contact.md'
- 'impressum.md'
- About: # Top-level item for general site information.
- License: 'license.md' # Link to license information.
- Contact: 'contact.md' # Link to contact page.
- Partners: 'partners.md' # Link to partners page.
- Impressum: 'impressum.md' # Link to impressum/legal page.
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment