<commit_before>.. _get-started:

Get Started
================

This section needs you have catsup installed.If you don't, please go and :ref:`Install it <installation>`

Create a site
---------------
It's pretty simple to create a site using catsup ::

    cd ~
    mkdir site
    cd site
    catsup init

You'll be asked some questions. These questions have default value, so if you don't want to change them,
just hit enter.

Create a post
----------------

Create a post ::

    touch posts/2013-02-08-helloworld.md

.. attention:: Post's filename should like ``year-month-day-title.md``. ``2013-2-2-hi.md`` is not vailed.

Then edit it with your favorite editor ::

    mate posts/2013-02-08-helloworld.md

Build your site
----------------
Now you have written your first post.Let's build your site ::

    cd ~/site
    catsup build

You can also preview your site using :ref:`Preview Server <preview-server>`
<commit_msg>update docs.start.rst<commit_after>.. _get-started:

Get Started
================

This section needs you have catsup installed.If you don't, please go and :ref:`Install it <installation>`

Init your site
---------------
It's pretty simple to create a site using catsup ::

    cd ~
    mkdir site
    cd site
    catsup init

After that, you need to change ``config.json`` ::

    vim config.json

Writing posts and pages
----------------

Let's write a post first ::

    vim posts/hello-world.md

Not, let's start writing the post ::

    # Hello, World!

    - time: 2013-08-25 23:30
    - tags: hello world

    ---

    Hello, World!
    This is my first post in catsup.

    ```python
    print("I love python")
    ```

Build your site
----------------
Now you have written your first post.Let's build your site ::

    cd ~/site
    catsup build

You can also preview your site using :ref:`Preview Server <preview-server>`

{'fraction_non_alphanumeric': 0.15169445938676707, 'fraction_numerical': 0.01828940290478752, 'mean_word_length': 2.5028248587570623, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4959951', 'n_tokens_mistral': 588, 'n_tokens_neox': 527, 'n_words': 226}