From eb05879df0fbe9c1e54073dff23a49d0fb9bdd64 Mon Sep 17 00:00:00 2001 From: Michel-FK Date: Tue, 2 Feb 2021 09:40:29 +0100 Subject: [PATCH] move new files and added directions for local test in the README.md Signed-off-by: Michel-FK --- README.md | 33 ++++++++++++++++++- .../features/hardware_characteristics.md | 0 .../{ => user_manual}/features/open_source.md | 0 mkdocs.yml | 4 +-- 4 files changed, 34 insertions(+), 3 deletions(-) rename docs/{ => user_manual}/features/hardware_characteristics.md (100%) rename docs/{ => user_manual}/features/open_source.md (100%) diff --git a/README.md b/README.md index ce6a7ef..b397a50 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,34 @@ This repository contains the FunKey Project documentation project. -The "[source](https://github.com/FunKey-Project/FunKey-Project.github.io/tree/source)" branch contains the source documents; they are processed by MkDocs to generate the resulting static site in the "[master](https://github.com/FunKey-Project/FunKey-Project.github.io/tree/master)" branch that is accessible through Github Pages at https://funkey-project.github.io/FunKey-Project.github.io/ \ No newline at end of file +The +"[source](https://github.com/FunKey-Project/FunKey-Project.github.io/tree/source)" +branch contains the source documents; they are processed by MkDocs to +generate the resulting static site in the +"[master](https://github.com/FunKey-Project/FunKey-Project.github.io/tree/master)" +branch that is accessible through Github Pages at +https://funkey-project.github.io/FunKey-Project.github.io/ + +## Local Build + +In order to build le documentation locally, you need to have a Python +3.x installed on your machine. + +You will need to isntall the mkdocs-material package and some required +plugins using the following command + +```pip install mkdocs-material mkdocs-minify-plugin mkdocs-section-index mkdocs-exclude mkdocs-redirects``` + +On Unix machines, you will probably need to install it as root user, using: + +```sudo pip install mkdocs-material mkdocs-minify-plugin mkdocs-section-index mkdocs-exclude mkdocs-redirects``` + +## Local Tests + +You can launch a local test server that will track all source file +changes and generate a static site on the fly using the following command: + +```mkdocs serve``` + +The test server is then accessible at: + +http://localhost:8000/ diff --git a/docs/features/hardware_characteristics.md b/docs/user_manual/features/hardware_characteristics.md similarity index 100% rename from docs/features/hardware_characteristics.md rename to docs/user_manual/features/hardware_characteristics.md diff --git a/docs/features/open_source.md b/docs/user_manual/features/open_source.md similarity index 100% rename from docs/features/open_source.md rename to docs/user_manual/features/open_source.md diff --git a/mkdocs.yml b/mkdocs.yml index 6d6e093..5f23ce4 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -138,8 +138,8 @@ nav: - 'Folder Organization': 'user_manual/features/folder_organization.md' - 'Quick Save': 'user_manual/features/quick_save.md' - 'Instant Action': 'user_manual/features/instant_action.md' - - 'Hardware Characteristics' : 'features/hardware_characteristics.md' - - 'Open Source' : 'features/open_source.md' + - 'Hardware Characteristics' : 'user_manual/features/hardware_characteristics.md' + - 'Open Source' : 'user_manual/features/open_source.md' - Tutorials: - Software: - 'Add New ROMs': 'user_manual/tutorials/software/add_roms.md'