Skip to content

Commit 3e49087

Browse files
committed
handbook: first import
1 parent 36021e5 commit 3e49087

File tree

6 files changed

+531
-0
lines changed

6 files changed

+531
-0
lines changed

handbook/Gemfile

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# frozen_string_literal: true
2+
3+
source "https://rubygems.org"
4+
5+
git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
6+
7+
# gem "rails"
8+
gem "logger"
9+
gem "jekyll"
10+
gem "github-pages", group: :jekyll_plugins
11+
12+
gem "webrick", "~> 1.7"

handbook/Gemfile.lock

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# frozen_string_literal: true
2+
3+
source "https://rubygems.org"
4+
5+
git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
6+
7+
# gem "rails"
8+
gem "logger"
9+
gem "jekyll"
10+
gem "github-pages", group: :jekyll_plugins
11+
12+
gem "webrick", "~> 1.7"

handbook/README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Build the documentation
2+
3+
The documentation is built using Github pages on each commit to the main branch.
4+
5+
## Build locally
6+
7+
Tested on Fedora 36 and Ubuntu 22.04.
8+
Install the dependencies make sure to install ruby >= 3.0.
9+
10+
- Fedora:
11+
```
12+
dnf module install ruby
13+
dnf install gcc g++
14+
```
15+
16+
- Ubuntu:
17+
```
18+
apt install build-essential ruby-full
19+
```
20+
21+
Install jekyll and all dependencies:
22+
```
23+
bundle config set --local path '.bundle/vendor'
24+
bundle install
25+
```
26+
27+
Build and serve the site locally:
28+
```
29+
bundle exec jekyll serve
30+
```

handbook/_config.yml

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# Welcome to Jekyll!
2+
#
3+
# This config file is meant for settings that affect your whole site, values
4+
# which you are expected to set up once and rarely edit after that. If you find
5+
# yourself editing these this file very often, consider using Jekyll's data files
6+
# feature for the data you need to update frequently.
7+
#
8+
# For technical reasons, this file is *NOT* reloaded automatically when you use
9+
# 'jekyll serve'. If you change this file, please restart the server process.
10+
11+
# Site settings
12+
# These are used to personalize your new site. If you look in the HTML files,
13+
# you will see them accessed via {{ site.title }}, {{ site.github_repo }}, and so on.
14+
# You can create any custom variable you would like, and they will be accessible
15+
# in the templates via {{ site.myvariable }}.
16+
title: NS8 dev manual
17+
description: NS8 - Developer manual
18+
remote_theme: pmarsceill/just-the-docs
19+
20+
baseurl: /ns8-core
21+
22+
permalink: pretty
23+
exclude: [vendor]
24+
25+
admin_manual: https://docs.nethserver.org/projects/ns8
26+
# Set a path/url to a logo that will be displayed instead of the title
27+
#logo: "/assets/images/just-the-docs.png"
28+
29+
# Enable or disable the site search
30+
search_enabled: true
31+
32+
# Set the search token separator for hyphenated-word search:
33+
search_tokenizer_separator: /[\s/]+/
34+
35+
# Enable or disable heading anchors
36+
heading_anchors: true
37+
38+
# Aux links for the upper right navigation
39+
aux_links:
40+
"NS8 on GitHub":
41+
- "//github.com/nethserver/ns8-core"
42+
43+
# Footer content appears at the bottom of every page's main content
44+
footer_content: ""
45+
46+
# Footer "Edit this page on GitHub" link text
47+
gh_edit_link: true
48+
gh_edit_link_text: "Edit this page on GitHub."
49+
gh_edit_repository: "https://github.com/NethServer/ns8-core"
50+
gh_edit_branch: "master"
51+
gh_edit_source: docs
52+
gh_edit_view_mode: "tree"
53+
54+
# Color scheme currently only supports "dark" or nil (default)
55+
color_scheme: nil
56+
57+
# Google Analytics Tracking (optional)
58+
# e.g, UA-1234567-89
59+
#ga_tracking: UA-2709176-10
60+
61+
plugins:
62+
- jekyll-seo-tag
63+
64+
compress_html:
65+
clippings: all
66+
comments: all
67+
endings: all
68+
startings: []
69+
blanklines: false
70+
profile: false

0 commit comments

Comments
 (0)