https://github.com/getnikola/nikola

A static website and blog generator
https://github.com/getnikola/nikola

python static-site static-site-generator

Last synced: 13 days ago
JSON representation

A static website and blog generator

• Host: GitHub
• URL: https://github.com/getnikola/nikola
• Owner: getnikola
• License: mit
• Created: 2012-04-14T13:53:22.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2024-08-28T20:41:53.000Z (2 months ago)
• Last Synced: 2024-09-29T01:06:34.134Z (about 1 month ago)
• Topics: python, static-site, static-site-generator
• Language: Python
• Homepage: https://getnikola.com/
• Size: 37.6 MB
• Stars: 2,599
• Watchers: 77
• Forks: 448
• Open Issues: 70
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.txt
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md
  • Support: docs/support.rst
  • Authors: AUTHORS.txt

Awesome Lists containing this project

• awesome-python-applications - Repo - line static site generator with incremental rebuilds and support for Markdown, reST, Jupyter notebooks, and HTML. `(linux, windows, mac)` (<a id="tag-static_site" href="#tag-static_site">Static Site</a>)
• awesome-jupyter-resources - GitHub - 2% open · ⏱️ 02.08.2022): (Jupyter-Notebook分享与格式转换)
• best-of-jupyter - GitHub - 2% open · ⏱️ 28.08.2024): (Notebook Sharing & Conversion)
• awesome-python-applications - Repo - line static site generator with incremental rebuilds and support for Markdown, reST, Jupyter notebooks, and HTML. `(linux, windows, mac)` (<a id="tag-static_site" href="#tag-static_site">Static Site</a>)
• awesome-static - **Nikola**
• awesome-starred - getnikola/nikola - A static website and blog generator (python)
• jimsghstars - getnikola/nikola - A static website and blog generator (Python)
• awesome-homelab - Nikola

README

        
Nikola, a Static Site and Blog Generator

========================================

In goes content, out comes a website, ready to deploy.

.. image:: http://img.shields.io/pypi/v/Nikola.svg

   :target: https://pypi.python.org/pypi/Nikola

.. image:: https://github.com/getnikola/nikola/workflows/Nikola%20CI/badge.svg

   :target: https://github.com/getnikola/nikola/actions

.. image:: http://img.shields.io/badge/license-MIT-green.svg

   :target: https://github.com/getnikola/nikola/blob/master/LICENSE.txt

Why Static Websites?

--------------------

Static websites are safer, use fewer resources, and avoid vendor and platform lock-in.

You can read more about this in the `Nikola Handbook`_

What Can Nikola Do?

-------------------

It has many features, but here are some of the nicer ones:

* `Blogs, with tags, feeds, archives, comments, etc.`__

* `Themable`_

* Fast builds, thanks to `doit`_

* Flexible, extensible via the dozens of `available plugins`_

* Small codebase (programmers can understand all of Nikola core in a day)

* `reStructuredText`_ or Markdown as input language (also Wiki, BBCode, Textile, and HTML)

* Easy `image galleries`_ (just drop files in a folder!)

* Syntax highlighting for almost any programming language or markup

* Multilingual sites, `translated to 50 languages.`__

* Doesn't reinvent wheels, leverages existing tools.

* Python 3.8+ compatible.

.. _Nikola Handbook: https://getnikola.com/handbook.html#why-static

__ https://users.getnikola.com/

.. _Themable: https://themes.getnikola.com

.. _doit: https://pydoit.org

.. _available plugins: https://plugins.getnikola.com/

.. _reStructuredText: https://getnikola.com/quickstart.html

.. _image galleries: https://getnikola.com/galleries/demo/

__ https://www.transifex.com/projects/p/nikola/

Nikola Architecture

-------------------

.. image:: https://getnikola.com/images/architecture.png

Installation Instructions

-------------------------

Assuming you have pip installed::

    pip install Nikola

For optional features::

    pip install "Nikola[extras]"

For tests::

    pip install "Nikola[extras,tests]"

For more information, see https://getnikola.com/