-
Notifications
You must be signed in to change notification settings - Fork 0
Quickstart
It is recommended to read all documentation files, or to ask questions via the typical communication methods, but, for the impatient ones, here are the summary instructions to get your static blog generated.
PynFact requires Python 3.5+. You may install it by running the following command in any terminal:
pip install pynfact
In some systems where Python 2 is the default version, it's possible
that the installer for Python 3 is called pip3.
Either way, you may run pip by invoking python directly:
python3 -m pip install pynfact
This will install pynfact to your local system. In case of wanting
pynfact available to all users, run the command as root or use
sudo:
sudo pip install pynfact
Choose name for your static weblog, for the sake of this examples, it'll
be used myblog. Run pynfact initializer by typing:
pynfact --init=myblog
A new folder named myblog will be created with the basic structure for
the website. Switch to it:
cd myblog
There's a dummy article with title "First Entry" in the folder
posts. Right now, that's the only post.
To generate the site, run:
pynfact --build
Every article and page will be parsed, in this case, only the post
first_entry.md. A new folder named _build is created containing
the deployed static code.
In order to preview the website:
pynfact --serve[=localhost [--port=4000]]
And use any browser at http://localhost:4000/
Send and keyboard interrupt (^C) to the terminal to finish the
preview.
If the site works, congratulations!, you may put aside the
first_entry.md post in the posts directory. It's possible to
delete it, but also recommended to keep it as a template. Just change
the extension to something that is not .md so it won't be generated
in future builds.
More help with: pynfact --help