Skip to content
This repository has been archived by the owner on Nov 29, 2018. It is now read-only.

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
Pandorabots authored and Pandorabots committed Mar 14, 2016
2 parents f9d2c66 + a40d441 commit 7291d05
Showing 1 changed file with 16 additions and 6 deletions.
22 changes: 16 additions & 6 deletions README.md
Expand Up @@ -25,6 +25,15 @@ This will open the Jekyll development server at
[localhost:4000](http://localhost:4000). It will also watch your files, so that
you don't have to rebuild/restart every time you make a change.

> Tip: if you aren't up to date with the remote repository, run `git pull` to
bring down any changes that you don't yet have. If you don't have any local
changes you want to integrate, you can just clone the repository as shown above.

## Pages

The docs site only has 2 pages (besides all the content pages) - these are generated
from index.html and about.md. Any changes to the front page should be made in index.html.

## Adding content

The site's content is driven by Jekyll collections, which allow you to group
Expand All @@ -34,11 +43,8 @@ our content ordered by date published.

Jekyll collections are stored in folders that have the name of the collection,
plus an underscore prefix. Inside, create a markdown file (.md) for your new
piece of content. So for a new "article":

```
$ cd _articles && touch my-article.md
```
piece of content. So for a new "article", go into the _articles directory and
create a file called "my-article.md".

This will create a new page accessible at
http://pandorabots.github.io/articles/my-article (the title of the file
Expand All @@ -60,7 +66,7 @@ ___
Here is my article!
```

The title will appear as a top level header on the page itself, and the layout
The title will appear in the sidebar index, and the layout
will determine how the header, footer, sidebar etc. are laid out. **Use
"default" as the layout for all content except for AIML references for which you
should use the "aiml" layout.**
Expand All @@ -76,6 +82,10 @@ collection prefixed with an underscore.

See _includes/sidebar.html for examples of how to add a collection to the navigation.

Finally, you'll want to copy-paste one of the click handlers in js/app.js to handle the collapse of your
new collection in the sidebar. Go to the bottom, duplicate one of the click handlers, and replace all instances of the old
collection's name with your new collection.

## CSS

The site's styles are 99% Bootstrap with some customizations made in css/style.css.
Expand Down

0 comments on commit 7291d05

Please sign in to comment.