Skip to content

flysim-apps/docs.flysim.io

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

FlyAround Documentation

Source for docs.flysim.io — the official documentation for FlyAround, a flight tracking and management platform for MSFS 2020/2024, X-Plane 11/12, and Prepar3D.

Built with Jekyll and the Just the Docs theme. Deployed automatically to GitHub Pages on every push to main.

Local development

bundle install
bundle exec jekyll serve

Open http://localhost:4000.

Structure

index.md              # Home page
docs/                 # Documentation pages
  faq/                # FAQ section
_sass/custom/         # Theme overrides (colors, layout, typography)
_includes/            # Custom head/header partials (fonts, theme toggle)
assets/
  images/             # Screenshots and images
  js/                 # Theme toggle script
_config.yml           # Jekyll + Just the Docs configuration

Adding content

Create a new .md file in docs/ with this front matter:

---
layout: default
title: Page Title
nav_order: 5
---

For a child page (e.g. under FAQ):

---
layout: default
title: Page Title
nav_order: 1
parent: FAQ
---

Images go in assets/images/ and are referenced as:

![Description]({{ site.baseurl }}/assets/images/filename.png)

Theming

The site supports light and dark mode via a toggle in the header. The theme is saved to localStorage and defaults to the user's OS preference. Color variables are defined in _sass/custom/custom.scss.

About

FlyAround Simuilations Documentation Site

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors