diff --git a/.gitignore b/.gitignore index 19fb794..77ecce9 100644 --- a/.gitignore +++ b/.gitignore @@ -4,3 +4,4 @@ .swp output/* pelican-plugins/ +plugins-custom/ diff --git a/.gitmodules b/.gitmodules deleted file mode 100644 index ecde5c3..0000000 --- a/.gitmodules +++ /dev/null @@ -1,3 +0,0 @@ -[submodule "plugins-custom"] - path = plugins-custom - url = https://git.vvvvvvaria.org/varia/plugins-custom diff --git a/README.md b/README.md index d9eb30d..8159ca0 100644 --- a/README.md +++ b/README.md @@ -2,33 +2,18 @@ > https://varia.zone -## Pelican +## Getting Started -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, Jinja and Pelican) into a set of html pages, files and images. This set -of documents is then uploaded to the server. - -One of the things that Pelican uses is _plugins_. They are used to add extra -features to the generation process of the website. - -In this repository there is a folder called 'plugins' and another one called -'plugins-custom'. - -The first one, 'plugins', is linked to the offical collection of plugins from -the Pelican project '[pelican-plugins](https://github.com/getpelican/pelican-plugins/)'. - -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: +### Clone ``` -$ git clone https://git.vvvvvvaria.org/varia/varia.website.git --recurse-submodules +$ 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 +### Install ``` $ python3 -m venv .venv @@ -36,7 +21,7 @@ $ source .venv/bin/activate $ pip install -r requirements.txt ``` -## Start +### Serve ``` $ pelican --autoreload @@ -44,20 +29,23 @@ $ pelican --autoreload Visit the website at [localhost:8000](http://localhost:8000) -## Update submodules +## Tools -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)) +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, Jinja and Pelican) into a set of html pages, files and images. This set +of documents is then uploaded to the server. -To update these submodules within your (already) cloned repository, first init the submodule, and then update it: +One of the things that Pelican uses is _plugins_. They are used to add extra +features to the generation process of the website. - cd /path/to/submodule +In this repository there is a folder called 'plugins' and another one called +'plugins-custom'. - git submodule init +The first one, 'plugins', is linked to the offical collection of plugins from +the Pelican project '[pelican-plugins](https://github.com/getpelican/pelican-plugins/)'. - git submodule update +The other one, 'plugins-custom', consists of plugins that we wrote ourself. ## Posting Content @@ -77,7 +65,6 @@ that each article contains at least the following at the top of the document: featured_image: /images/image.png Articles are written in a markup language called markdown. - [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 you. diff --git a/plugins-custom b/plugins-custom deleted file mode 160000 index 5364009..0000000 --- a/plugins-custom +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 53640095309c741081113d38c4566428d0e67b03