No known key found for this signature in database
GPG Key ID: 5E2EF5A63E3718CC
6 changed files with
80 additions and
0 deletions
-
.gitignore
-
Makefile
-
README.md
-
docs/index.md
-
mkdocs.yml
-
requirements.txt
|
@ -0,0 +1,2 @@ |
|
|
|
|
|
site/ |
|
|
|
|
|
src/ |
|
@ -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 |
|
@ -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 |
|
@ -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 |
|
@ -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 |
|
@ -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 |