From 3f30b65b7ee2e50adb64f11470c9188293cf3fe3 Mon Sep 17 00:00:00 2001 From: Quinten <58103738+hexa-one@users.noreply.github.com> Date: Mon, 1 Nov 2021 12:58:50 +0100 Subject: [PATCH] add index pages --- markdown/articles/build/index.md | 23 ++++ markdown/articles/contribute/index.md | 34 +++++ markdown/articles/developer/index.md | 74 +++++++++++ markdown/articles/hardware/index.md | 21 +++ markdown/articles/index.md | 176 ++++++++++++++++++-------- markdown/articles/install/index.md | 74 +++++++++++ markdown/articles/license/index.md | 21 +++ markdown/articles/os/index.md | 34 +++++ markdown/articles/pangolin/index.md | 33 +++++ markdown/articles/sidebar.md | 52 ++++++++ tools/docgen/bin/docgen.dart | 4 +- 11 files changed, 492 insertions(+), 54 deletions(-) create mode 100644 markdown/articles/build/index.md create mode 100644 markdown/articles/contribute/index.md create mode 100644 markdown/articles/developer/index.md create mode 100644 markdown/articles/hardware/index.md create mode 100644 markdown/articles/install/index.md create mode 100644 markdown/articles/license/index.md create mode 100644 markdown/articles/os/index.md create mode 100644 markdown/articles/pangolin/index.md create mode 100644 markdown/articles/sidebar.md diff --git a/markdown/articles/build/index.md b/markdown/articles/build/index.md new file mode 100644 index 00000000..a0b3dd01 --- /dev/null +++ b/markdown/articles/build/index.md @@ -0,0 +1,23 @@ +--- +title: Build +permalink: build/index.html +summary: Build dahliaOS +--- +## Build dahliaOS + +
+ + +
+

Buildroot

+
+ + +
+ Building dahliaOS. +
+ +
+ + +
\ No newline at end of file diff --git a/markdown/articles/contribute/index.md b/markdown/articles/contribute/index.md new file mode 100644 index 00000000..5a5fa634 --- /dev/null +++ b/markdown/articles/contribute/index.md @@ -0,0 +1,34 @@ +--- +title: contribute +permalink: contribute/index.html +summary: contribute to dahliaOS +--- +## contribute + +
+ + +
+

Contributing

+
+ + +
+ Learn how to Contribute. +
+ +
+ + + + +
+

Code of Conduct

+
+
+ The Code of Conduct. +
+
+ +
+
\ No newline at end of file diff --git a/markdown/articles/developer/index.md b/markdown/articles/developer/index.md new file mode 100644 index 00000000..cbb95c1d --- /dev/null +++ b/markdown/articles/developer/index.md @@ -0,0 +1,74 @@ +--- +title: developer +permalink: developer/index.html +summary: developing dahliaOS +--- +## developing dahliaOS + +
+ + +
+

Setting up FImage for Application Development

+
+ + +
+ +
+ +
+ + + +
+

Running a Flutter App on Fuchsia with FImage

+
+
+ +
+
+ +
+
+ + + +
+

Packaging

+
+
+ Packaging your app for dahliaOS. +
+
+ +
+
+ + + +
+

Submitting

+
+
+ Submitting your app for dahliaOS. +
+
+ +
+
+ + + + +
+

Roadmap

+
+
+ The dahliaOS roadmap. +
+
+ +
+
+
\ No newline at end of file diff --git a/markdown/articles/hardware/index.md b/markdown/articles/hardware/index.md new file mode 100644 index 00000000..6fe8eb79 --- /dev/null +++ b/markdown/articles/hardware/index.md @@ -0,0 +1,21 @@ +--- +title: Hardware +permalink: hardware/index.html +summary: List of dahliaOS Supported Devices. +--- +## Hardware + +
+ + +
+

Supported Devices

+
+ + +
+ List of Supported Devices. +
+ +
+
\ No newline at end of file diff --git a/markdown/articles/index.md b/markdown/articles/index.md index a753ca62..b779a7e8 100644 --- a/markdown/articles/index.md +++ b/markdown/articles/index.md @@ -1,52 +1,124 @@ ---- -title: Documentation -summary: dahliaOS Documentation overview ---- -## dahliaOS Documentation - -- Getting started - - - [Overview](/) - -- Install - - - [EFI (x86_64)](/install/efi) - - [BIOS (x86_64)](/install/legacy) - - [QEMU (cli)](/install/QEMU-cli) - - [QEMU (gui)](/install/QEMU-gui) - - [VirtualBox](/install/virtualbox) - -- Hardware - - - [Supported Devices](/hardware/support) - -- OS - - - [Linux Based](/os/linux) - - [Zircon Based (FImage)](/os/fimage) - -- Pangolin - - - [Pangolin on Linux](/pangolin/pangolin-linux) - - [Pangolin Desktop](/pangolin/pangolin) - -- Build - - - [Buildroot](/build/buildroot) - -- Developers - - - [Setting up FImage for Application Development](/developer/fimage-setup) - - [Running a Flutter App on Fuchsia with FImage](/developer/flutter-fuchsia) - - [Packaging](/developer/packaging) - - [Submitting](/developer/submitting) - - [Roadmap](/developer/roadmap) - -- Contribute - - - [Contributing](/contribute/contributing) - - [Code of Conduct](/contribute/conduct) - -- License - - - [License](/license/LICENSE) +--- +title: Documentation +summary: dahliaOS Documentation overview +--- +## dahliaOS Documentation + +
+ + +
+

Getting Started

+
+
+ Overview +
+
+ +
+
+ + + +
+

Install

+
+
+ Installing dahliaOS. +
+
+ +
+
+ + + +
+

Hardware

+
+
+ List of Supported Devices. +
+
+ +
+
+ + + +
+

OS

+
+
+ Info about the underlying operating system. +
+
+ +
+
+ + + + +
+

Pangolin

+
+
+ Info about the Pangolin desktop. +
+
+ +
+
+ + + +
+

Build

+
+
+ Building dahliaOS. +
+
+ +
+
+ + + +
+

Developers

+
+
+ Info on developing for dahliaOS. +
+
+ +
+
+ + + +
+

Contribute

+
+
+ Info about contributing. +
+
+ +
+
+ + +
+

License

+
+
+ The license. +
+
+ +
+
+
\ No newline at end of file diff --git a/markdown/articles/install/index.md b/markdown/articles/install/index.md new file mode 100644 index 00000000..78581d56 --- /dev/null +++ b/markdown/articles/install/index.md @@ -0,0 +1,74 @@ +--- +title: Install +permalink: install/index.html +summary: Install dahliaOS +--- +## Install dahliaOS + +
+ + +
+

EFI (64BIT)

+
+ + +
+ Install on 64 bit uefi hardware. +
+ +
+ + + +
+

BIOS (64BIT)

+
+
+ Install on 64 bit bios hardware. +
+
+ +
+
+ + + +
+

QEMU (CLI)

+
+
+ Install on QEMU with the command line. +
+
+ +
+
+ + + +
+

QEMU (Virt Manager)

+
+
+ Install on QEMU with virt manager. +
+
+ +
+
+ + + + +
+

VirtualBox

+
+
+ Install on VirtualBox. +
+
+ +
+
+
\ No newline at end of file diff --git a/markdown/articles/license/index.md b/markdown/articles/license/index.md new file mode 100644 index 00000000..a76a2754 --- /dev/null +++ b/markdown/articles/license/index.md @@ -0,0 +1,21 @@ +--- +title: license +permalink: license/index.html +summary: license +--- +## license + +
+ + +
+

License

+
+ + +
+ The License. +
+ +
+
\ No newline at end of file diff --git a/markdown/articles/os/index.md b/markdown/articles/os/index.md new file mode 100644 index 00000000..fb286f3e --- /dev/null +++ b/markdown/articles/os/index.md @@ -0,0 +1,34 @@ +--- +title: OS +permalink: os/index.html +summary: Info about os builds. +--- +## OS + +
+ + +
+

Linux Based

+
+ + +
+ Info about linux based builds. +
+ +
+ + +
+

Zircon Based (FImage)

+
+ + +
+ Info about FImage. +
+ +
+ +
\ No newline at end of file diff --git a/markdown/articles/pangolin/index.md b/markdown/articles/pangolin/index.md new file mode 100644 index 00000000..c71f2867 --- /dev/null +++ b/markdown/articles/pangolin/index.md @@ -0,0 +1,33 @@ +--- +title: Pangolin +permalink: pangolin/index.html +summary: Pangolin +--- +## Pangolin + +
+ + +
+

Pangolin on Linux

+
+ + +
+ Running Pangolin on other linux distros. +
+ +
+ + +
+

Pangolin Desktop

+
+ + +
+ Info about the Pangolin desktop. +
+ +
+
\ No newline at end of file diff --git a/markdown/articles/sidebar.md b/markdown/articles/sidebar.md new file mode 100644 index 00000000..a753ca62 --- /dev/null +++ b/markdown/articles/sidebar.md @@ -0,0 +1,52 @@ +--- +title: Documentation +summary: dahliaOS Documentation overview +--- +## dahliaOS Documentation + +- Getting started + + - [Overview](/) + +- Install + + - [EFI (x86_64)](/install/efi) + - [BIOS (x86_64)](/install/legacy) + - [QEMU (cli)](/install/QEMU-cli) + - [QEMU (gui)](/install/QEMU-gui) + - [VirtualBox](/install/virtualbox) + +- Hardware + + - [Supported Devices](/hardware/support) + +- OS + + - [Linux Based](/os/linux) + - [Zircon Based (FImage)](/os/fimage) + +- Pangolin + + - [Pangolin on Linux](/pangolin/pangolin-linux) + - [Pangolin Desktop](/pangolin/pangolin) + +- Build + + - [Buildroot](/build/buildroot) + +- Developers + + - [Setting up FImage for Application Development](/developer/fimage-setup) + - [Running a Flutter App on Fuchsia with FImage](/developer/flutter-fuchsia) + - [Packaging](/developer/packaging) + - [Submitting](/developer/submitting) + - [Roadmap](/developer/roadmap) + +- Contribute + + - [Contributing](/contribute/contributing) + - [Code of Conduct](/contribute/conduct) + +- License + + - [License](/license/LICENSE) diff --git a/tools/docgen/bin/docgen.dart b/tools/docgen/bin/docgen.dart index d4278cb3..5c3fa2e0 100644 --- a/tools/docgen/bin/docgen.dart +++ b/tools/docgen/bin/docgen.dart @@ -4,7 +4,7 @@ //DOCGEN_DOCUMENT_TITLE_GGFF: This is the name of the document, used in the heading and title //DOCGEN_DOCUMENT_DESCRIPTION_GGFF: This is the documents description, used in generated embeds and Google //DOCGEN_DOCUMENT_PATH_GGFF: This is the path to the document, shown in the top. -//DOCGEN_SIDEBAR_LIST_GGFF: This is the content of index.md, parsed, and the top header stripped. +//DOCGEN_SIDEBAR_LIST_GGFF: This is the content of sidebar.md, parsed, and the top header stripped. //Declare other in-document variables with the suffix _GGFF to prevent accidental insertion import 'dart:io'; import 'package:markdown/markdown.dart'; @@ -128,7 +128,7 @@ void main(List arguments) async { var documentInQuestion = (await fm.parseFile(relPath + walkedDocs[i].inFileName)).content; var header = await File('header.html').readAsString(); - var book = (await fm.parseFile(relPath + 'index.md')).content; + var book = (await fm.parseFile(relPath + 'sidebar.md')).content; var footer = await File('footer.html').readAsString(); var documentPath = walkedDocs[i].inFileName.split('/')[0] == 'index.md' ? 'Documentation' : 'Documentation > ' +