fix readme for right repo
This commit is contained in:
Vicky Steeves
parent
0e11ed82d9
commit
b8e60c2ccb
88
README.md
88
README.md
|
|
@ -1,5 +1,5 @@
|
|||
### About
|
||||
This is the code for the website [https://investigating-archiving-git.gitlab.io/](https://investigating-archiving-git.gitlab.io/), an informational site for the Sloan-funded project, "Investigating and Archiving the Scholarly Git Experience." This site is built using [Nikola](https://getnikola.com/), a static site generator that relies on python3. The instructions for compiling and building the website are below.
|
||||
This is the code for the website [https://lissarchive.org](https://lissarchive.org), an informational site for the LIS Scholarship Archive, a repository for LIS work. This site is built using [Nikola](https://getnikola.com/), a static site generator that relies on python3. The instructions for compiling and building the website are below.
|
||||
|
||||
### Building
|
||||
I would recommend you use a virtualenv to build and view this website. This is a Python tool to create isolated Python environments. The HitchHiker's Guide to Python has a [great guide](http://docs.python-guide.org/en/latest/dev/virtualenvs/) on virtual environments that I used to learn how to use/interact with virtualenvs.
|
||||
|
|
@ -21,94 +21,14 @@ Now, you can get started and install all of the dependecies of this site in its
|
|||
$ pip install Nikola['extras']
|
||||
|
||||
# clone this repo
|
||||
$ git clone git@gitlab.com:VickySteeves/investigating-archiving-git.gitlab.io.git
|
||||
$ git clone git@gitlab.com:VickySteeves/lissarchive.git
|
||||
|
||||
# change directory (cd) so you are in the right folder for the website
|
||||
$ cd investigating-archiving-git.gitlab.io
|
||||
$ cd lissarchive
|
||||
|
||||
# build the website
|
||||
$ nikola build
|
||||
|
||||
# see the website
|
||||
$ nikola serve -b
|
||||
</pre></code>
|
||||
|
||||
### Authoring Blog Posts
|
||||
|
||||
All blog posts should go in the `updates` folder. Blog posts should be Text (`.txt`), reStructured Text (`.rst`), Markdown (`.md`), or `.html`. If you'd like to write a post in another format, you'll have to edit the `conf.py` [file](https://gitlab.com/investigating-archiving-git/investigating-archiving-git.gitlab.io/blob/master/conf.py) to add other [accepted input formats](https://getnikola.com/handbook.html#supported-input-formats), starting at [line 126](https://gitlab.com/investigating-archiving-git/investigating-archiving-git.gitlab.io/blob/master/conf.py#L126).
|
||||
|
||||
When you author blog posts, you should always have the following metadata at the beginning of the file:
|
||||
|
||||
+ Title -- this is what appears on the live post
|
||||
+ Slug -- the end of the URL to the post. It should have no spaces, only Aa-Zz, 0-9, -, and _
|
||||
+ Date -- YYYY-MM-DD
|
||||
+ Author -- keep your name consistent with every post, please!
|
||||
+ Link -- this will go to the source link for the post on GitLab (should look like: https://gitlab.com/investigating-archiving-git/investigating-archiving-git.gitlab.io/blob/master/updates/2019-05-06.html)
|
||||
+ Description -- this is used for SEO purposes, so a small description of the post
|
||||
+ Type -- Nikola has [two post types](https://getnikola.com/handbook.html#post-types). For our purposes, we'll always use `text`.
|
||||
|
||||
If your posts are in HTML, they should look something like this:
|
||||
|
||||
```
|
||||
<!--
|
||||
.. title:
|
||||
.. slug:
|
||||
.. date:
|
||||
.. author:
|
||||
.. link:
|
||||
.. description:
|
||||
.. type: text
|
||||
-->
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<body>
|
||||
|
||||
<p>Content of your post</p>
|
||||
|
||||
<img src="/images/something.png">
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
||||
```
|
||||
|
||||
Here is a guide to writing basic HTML: https://www.w3schools.com/html/html_basic.asp
|
||||
|
||||
For Markdown, text, and reStructred Text, it should look something like this:
|
||||
|
||||
```
|
||||
.. title:
|
||||
.. slug:
|
||||
.. date:
|
||||
.. author:
|
||||
.. link:
|
||||
.. description:
|
||||
.. type: text
|
||||
|
||||
Content of your post
|
||||
|
||||
.. image:: /images/something.png
|
||||
|
||||
```
|
||||
|
||||
There are a few handy guides for writing in these formats as well:
|
||||
|
||||
+ Markdown: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
|
||||
+ reStructured Text: https://github.com/ralsina/rst-cheatsheet/blob/master/rst-cheatsheet.rst
|
||||
|
||||
All image files for the blog posts should go into the `images` folder. Make sure when you reference your image from the post, you add the `/` before the calling the images folder to help Nikola find it.
|
||||
|
||||
If you don't want to show the complete content of your post in the blog index and RSS feed, you can display just the beginning of them using the `TEASER` magical comment. The Nikola documentation provides a way to do this for each type of post here: https://getnikola.com/handbook.html#teasers. I usually do this to make reading the blog index easier.
|
||||
|
||||
When you're done authoring the blog posts and want to preview it locally, build and serve the website the same way you would otherwise:
|
||||
|
||||
```
|
||||
# build the website
|
||||
$ nikola build
|
||||
|
||||
# browser pops up and shows site
|
||||
$ nikola serve -b
|
||||
```
|
||||
|
||||
Happy writing!
|
||||
</pre></code>
|
||||
Loading…
Reference in New Issue