Commit 23e5a62d authored by chrissi^'s avatar chrissi^

Add README

Signed-off-by: chrissi^'s avatarChris Fiege <chris@tinyhost.de>
parent b382a60b
How to use a flamingo-based website?
====================================
Requirements
------------
You will need at least Python 3.5.3 to run the live-server.
Writing Content
---------------
To write new content create a new file in `content/`.
If there is already a file that looks simliar to what you want
to do (e.g. write a blog post) just copy it.
If you want to manipulate existing content:
Take a look into the generated HTML. Between `</head>` and `<body>` is
a section containing some information about the file.
Find the file listed in `path` inside the `context/`-directory and
just edit the file ¯\_(ツ)_/¯
Preview
-------
Go into the base path of the project (that is where is `Makefile` is)
and type:
make server
Open your webbroser and navigate to http://localhost:8080/live-server .
A page in the live-server will reload every time to change the input.
Be aware that sometimes menus are broken in the preview.
Test-Deploy
-----------
If you want your changes to be reviewed by someone else you can push
your changed to a branch namend `testbed`.
Be aware that this branch may be overridden by others.
Always keep your changes in a personalized topic branch, e.g. `chrissi/blog`.
Your preview will be availalble at
https://testbed.freifunk-bs.de
Deploy
------
Push your changes to `master` and wait for the pipeline to finish
deployment.
......@@ -15,6 +15,14 @@
<link href="/css/small-business.css" rel="stylesheet">
<link href="/css/font-awesome.min.css" rel="stylesheet">
</head>
<!--
Generated with flamingo.
This page was generated with this context-information:
url: {{ content.url }}
output: {{ content.output }}
template: {{ content.template }}
path: {{ content.path }} (look out for this file if you want to change this page)
-->
<body>
<nav class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment