Coder Social home page Coder Social logo

pomash's Introduction

About

Current Version: v2.1

Pomash is a lightweight blog system. Powered by Tornado Web Framework.

Build up

Requirements

  • python version >= 3.x

How to get Pomash:

git clone https://github.com/JmPotato/Pomash.git
cd Pomash
pip3 install -r requirements.txt

You should edit the settings.py to set up before running run.py. Here is a explanation for settings.py:

  • blog_name Your blog's name.
  • blog_author Your name.
  • blog_url Your blog's URL.
  • theme The theme you're using.
  • dark_mode The switch for dark mode. 0.Off & 1.On & 2.Auto. PS: Need theme support.
  • pygments_style_light The pygments style for light mode.
  • pygments_style_dark The pygments style for dark mode.
  • post_per_page The number of articles you want to display on the home page.
  • twitter_card Enable/Disable the twitter card function.
  • twitter_username Your twitter username.
  • analytics Google Analytics code. If you don't know what it is, just leave it empty.
  • comment_system Pomash currently supports Disqus or Valine as the comment system. 0 means turn off the comment. 1 means using Disqus. 2 means using Valine.
  • disqus_name If you choose Disqus as your comment system, please fill this with your own code.
  • valine_app_id/key If you choose Valine as your comment system, please fill this with your own LeanCloud app id/key. You can look this as a reference.
  • dropbox_app_token If you want to use the backup function, get a Dropbox app token here first.
  • cookie_secret The string used to encrypt your cookie. PLEASE CHANGE THIS TO YOUR OWN STRING.
  • login_username The admin username. Initial password of admin is admin. Please change it as soon as possible.
  • DeBug Developer setting. Normal user could just ignore it.

After customizing settings.py and initialize the database, you could put Pomash online.

python init_db.py
python run.py --port=8080

Usage

Pomash uses Markdown to write posts and pages. LaTeX is also supported.

Note: To avoid conflict between LaTeX and Markdown, Pomash removed the emphasis syntax *word* and _word_ which you should use <em>word</em> as an alternative.

#Hello World

```python
print('Hello, World!')
```

Hello, World!

Inline LaTeX: $\int_a^b f(x)\mathrm{d}x$

New line LaTeX: $$\sum_{i=0}^{n}i^2$$

<em>This is a emphasis.</em>

**This is a double emphasis.**

~~This is a strikethrough.~~

* Hello
* World

Theme

Pomash's theme is called Potheme. Here is a Potheme list:

Other Reference

A Chinese guide for setting up.(Maybe a little outdated)

License

Please read the MIT-LICENSE

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.