Remove submodules and jiggle docs again

This commit is contained in:
Luke Murphy 2021-01-19 22:08:01 +01:00
parent ab94cb5b21
commit aa24011007
No known key found for this signature in database
GPG Key ID: 5E2EF5A63E3718CC
4 changed files with 29 additions and 45 deletions

1
.gitignore vendored
View File

@ -4,3 +4,4 @@
.swp .swp
output/* output/*
pelican-plugins/ pelican-plugins/
plugins-custom/

3
.gitmodules vendored
View File

@ -1,3 +0,0 @@
[submodule "plugins-custom"]
path = plugins-custom
url = https://git.vvvvvvaria.org/varia/plugins-custom

View File

@ -2,7 +2,34 @@
> https://varia.zone > https://varia.zone
## Pelican ## Getting Started
### Clone
```
$ git clone https://git.vvvvvvaria.org/varia/varia.website.git
$ cd varia.website
$ git clone https://github.com/getpelican/pelican-plugins/
$ git clone https://git.vvvvvvaria.org/varia/plugins-custom
```
### Install
```
$ python3 -m venv .venv
$ source .venv/bin/activate
$ pip install -r requirements.txt
```
### Serve
```
$ pelican --autoreload
```
Visit the website at [localhost:8000](http://localhost:8000)
## Tools
The Varia website is made with Pelican, a static site generator written in The Varia website is made with Pelican, a static site generator written in
Python. This means that the website is first generated on a computer (using Python. This means that the website is first generated on a computer (using
@ -20,45 +47,6 @@ the Pelican project '[pelican-plugins](https://github.com/getpelican/pelican-plu
The other one, 'plugins-custom', consists of plugins that we wrote ourself. The other one, 'plugins-custom', consists of plugins that we wrote ourself.
## Clone
To clone both the varia.website and pelican-plugins repository, add the --recurse-submodules option in your git clone command:
```
$ git clone https://git.vvvvvvaria.org/varia/varia.website.git --recurse-submodules
```
## Install
```
$ python3 -m venv .venv
$ source .venv/bin/activate
$ pip install -r requirements.txt
```
## Start
```
$ pelican --autoreload
```
Visit the website at [localhost:8000](http://localhost:8000)
## Update submodules
We are currently using two submodules:
- pelican-plugins ([https://github.com/getpelican/pelican-plugins](https://github.com/getpelican/pelican-plugins))
- plugins-custom ([https://git.vvvvvvaria.org/varia/plugins-custom](https://git.vvvvvvaria.org/varia/plugins-custom))
To update these submodules within your (already) cloned repository, first init the submodule, and then update it:
cd /path/to/submodule
git submodule init
git submodule update
## Posting Content ## Posting Content
We're using Pelican to generate a static website. The main way to add content We're using Pelican to generate a static website. The main way to add content
@ -77,7 +65,6 @@ that each article contains at least the following at the top of the document:
featured_image: /images/image.png featured_image: /images/image.png
Articles are written in a markup language called markdown. Articles are written in a markup language called markdown.
[Here](https://daringfireball.net/projects/markdown/syntax) is an overview of [Here](https://daringfireball.net/projects/markdown/syntax) is an overview of
the syntax. You can also use the online editor in this Gitea interface to help the syntax. You can also use the online editor in this Gitea interface to help
you. you.

@ -1 +0,0 @@
Subproject commit 53640095309c741081113d38c4566428d0e67b03