LibrePages/docs
4
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity
LibrePages documentation website https://docs.librepages.org
23 commits 2 branches 0 tags 372 KiB
SCSS 28%
HTML 25%
Shell 22.4%
JavaScript 22%
Makefile 2.6%
Find a file
Che 44b4a068f4 Table of Contents for Landing Page 
If no content has been set for the landing page, put up a table of
contents by default. Many simple sites don't need a landing page that
has more than a table of contents.
2022-06-02 22:56:49 -04:00
content Update page.md 2022-05-16 12:52:05 +02:00
sass add borders to tables 2022-05-16 12:46:33 +02:00
static logo_fix 2021-06-27 10:23:46 +03:00
templates Table of Contents for Landing Page 2022-06-02 22:56:49 -04:00
.gitignore gitignore added 2021-03-14 16:02:51 +03:00
config.toml Add option to make logo always clickable 2022-05-29 04:30:56 -04:00
LICENSE Create LICENSE 2021-03-14 16:05:54 +03:00
README.md readme and minor fixes 2021-03-14 14:36:06 +03:00
screenshot.png readme and minor fixes 2021-03-14 14:36:06 +03:00
theme.toml readme and minor fixes 2021-03-14 14:36:06 +03:00

README.md

An easy way to create a document library for your project

Demo: https://easydocs.codeandmedia.com/

This theme for Zola (static site engine) helps you build and publish your project docs easily and fast. Zola is just one binary that outputs html-pages and additional static assets after building your docs written in Markdown. Thus, you can take the theme, your md-files, Zola and gain flexible and simple website for documentation.

Step-by-step

As you may have heard Zola is quite flexible :) So, the scenario below is one of hundreds possible ways to make things done, feel free to find your best. Also, Zola provides their own mechanism to install and use themes, see the docs.

  1. Fork the repo and replace demo-content inside content folder with yours. But take a look to _index.md files. It contains title and when you want to have anchor right of your headers add insert_anchor_links = "right" to each index. theme.toml, screenshot and readme may be deleted too.
  2. Inside config.toml change URL and title on your own. In extra section you can specify path to your GitHub API for version below the logo on nav, favicon and logo itself. Or just remove the lines if you don't need it. Also, you can configure or turn on some additional settings related to Zola. Specification is here.
  3. In sass/_variables.scss you may change font, color or backgound if you want.
  4. Almost done. Now, you should decide how you want to build and where will be hosted your website. You can build it locally and upload to somewhere. Or build in GitHub Actions and host on GitHub Pages / Netlify / CloudFlare Pages / AnyS3CloudStorage. Howto for GitHub Pages. My example of GitHub workflow with 2-steps build (the first checks for links and spelling errors, the second uploads to Azure). Dockerfile to make Docker image.

Enjoy your docs!