From 2331d73d3cf2c21ab1c3087d140b461bd34ecaae Mon Sep 17 00:00:00 2001 From: Luke Murphy Date: Fri, 17 May 2019 13:09:34 +0200 Subject: [PATCH] Bootstrapping the manual --- .gitignore | 2 ++ Makefile | 8 ++++++++ README.md | 18 ++++++++++++++++++ docs/index.md | 30 ++++++++++++++++++++++++++++++ mkdocs.yml | 18 ++++++++++++++++++ requirements.txt | 4 ++++ 6 files changed, 80 insertions(+) create mode 100644 .gitignore create mode 100644 Makefile create mode 100644 README.md create mode 100644 docs/index.md create mode 100644 mkdocs.yml create mode 100644 requirements.txt diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..2480ecf --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +site/ +src/ diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..20bc7c8 --- /dev/null +++ b/Makefile @@ -0,0 +1,8 @@ +build: + @mkdocs build && \ + mkdir site/pd site/epub && \ + mkdocscombine -o site/pd/manual.pd --no-titles && \ + pandoc --toc -f markdown+grid_tables -t epub -o site/epub/manual.epub site/pd/manual.pd + +serve: + @mkdocs serve diff --git a/README.md b/README.md new file mode 100644 index 0000000..ac47e60 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# Manual.Bibliotecha.Info + +The manual for Bibliotecha. + +> https://manual.bibliotecha.info + +# Contribute to the Manual + +``` +$ python3 -m venv .venv && source .venv/bin/activate +$ pip install -r requirements.txt +$ make serve +``` + +References: + + * [Python virtual environment](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/#creating-a-virtual-environment) documentation + * [MkDocs](https://www.mkdocs.org/) documentation diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..691b055 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,30 @@ +# Bibliotecha Manual + +> [bibliotecha.info/](https://bibliotecha.info/) + +> Bibliotecha is a framework to facilitate the local distribution of digital +> publications within a small community. It relies on a microcomputer running +> open-source software to serve books over a local wifi hotspot. Using the +> browser to connect to the library one can retrieve or donate texts. +> Bibliotecha proposes an alternative model of distribution of digital texts +> that allows specific communities to form and share their own collections. + +--- + +[TOC] + +--- + +## Introduction + +Welcome to the Bibliotecha manual! + +## Prerequisites + +## Pre-installation + +## Installation + +## Post-installation + +## Troubleshooting diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..2e2d628 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,18 @@ +site_name: Bibliotecha +site_url: https://manual.bibliotecha.info/ + +theme: alabaster + +nav: + - Manual: index.md + +markdown_extensions: + - abbr + - toc + +plugins: + - search: + lang: en + - pdf-export: + combined: True + combined_output_path: pdf/manual.pdf diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..3f62df9 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,4 @@ +mkdocs==1.0.4 +mkdocs-pdf-export-plugin==0.5.5 +mkdocs-alabaster==0.8.0 +-e git+https://github.com/twardoch/mkdocs-combine.git#egg=mkdocs-combine