https://github.com/statsim/theme
StatSim theme for Pelican (static site generator). Used in the Docs and Models sections
https://github.com/statsim/theme
Last synced: 4 months ago
JSON representation
StatSim theme for Pelican (static site generator). Used in the Docs and Models sections
- Host: GitHub
- URL: https://github.com/statsim/theme
- Owner: statsim
- Created: 2019-02-24T21:27:11.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-07-07T08:37:12.000Z (almost 5 years ago)
- Last Synced: 2025-02-24T01:15:28.469Z (over 1 year ago)
- Language: HTML
- Homepage:
- Size: 42 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# StatSim theme for the models and docs sections
Based on Pelican-Blue theme
[Pelican](http://blog.getpelican.com/) Static Site Generator
## Installation
You can install Pelican-Blue theme to your earlier Pelican project or create a new project from the Pelican [Quickstart](http://docs.getpelican.com/en/3.6.3/quickstart.html) guide.
* Clone the repository
```
$ git clone https://github.com/Parbhat/pelican-blue.git
```
* Create a `THEME` variable in your `pelicanconf.py` file and set its value to the location of pelican-blue theme.
```python
THEME = 'path-to-pelican-blue-theme'
```
If you have placed the `pelican-blue` theme inside your project's pelican-themes folder, change the `THEME` variable in `pelicanconf.py` to
```python
THEME = 'pelican-themes/pelican-blue'
```
* Add the following code to your `pelicanconf.py` file to display the social icons.
```python
SOCIAL = (('linkedin', 'https://www.linkedin.com/in/username'),
('github', 'https://github.com/username'),
('twitter', 'https://twitter.com/username'),
)
```
* That's it! You have installed `pelican-blue`. To see the Theme in action run the devserver
```
make devserver
```
**Note:** If you are new to Pelican Static Site Generator, you can read the Pelican [Docs](http://docs.getpelican.com/en/3.6.3/) to learn the working of Pelican. You can also customize the theme after reading the documentation.
## Settings
### pelicanconf.py
Pelican-Blue theme use the following settings. You can add the following to your `pelicanconf.py` to get the site shown in the screenshots.
```python
SIDEBAR_DIGEST = 'Programmer and Web Developer'
FAVICON = 'url-to-favicon'
DISPLAY_PAGES_ON_MENU = True
TWITTER_USERNAME = 'twitter-user-name'
MENUITEMS = (('Blog', SITEURL),)
```
When developing locally, set the following variable:
```
SITEURL = 'http://localhost:8000'
```
### publishconf.py
When you are ready to publish your site add the following settings to `publishconf.py` file
```python
SITEURL = 'http://your-domain-address'
FEED_ALL_ATOM = 'feeds/all.atom.xml'
CATEGORY_FEED_ATOM = 'feeds/%s.atom.xml'
MENUITEMS = (('Blog', SITEURL),)
DISQUS_SITENAME = ""
GOOGLE_ANALYTICS = ""
```
For more information on publishing your site, read the publishing [docs](http://docs.getpelican.com/en/3.6.3/publish.html)
## Contributing
Your contributions are welcome to improve the `pelican-blue` theme.