nci2: a simple blog manager and static site generator for neocities

nci2 is a CLI application and a blog generator/manager for neocities. nci2 is an improved version of the original and simpler nci webscript.

I'm using this blog manager for my blog.

nci2 lets you post, edit and delete blog entries without editing the HTML code of your blog. It makes managing your blog easier and faster.

How nci2 works

nci2 is pretty similar to the old webscript, except that now nci is actually installed on your system using pip. The way nci and nci2 work is mainly inspired by the way the VCS git works. You create a specific (local) directory for your website, and then you initialize the nci2 system in it, so you can easily manage your blog from a directory in your computer, and then you upload it to neocities whenever you want to.

Why nci2

There are a lot of blog managers out there I think. Use nci2 if you have a blog on neocities that you need to manage quickly, and if you like the way this software works, of course.

Installation

Installing nci2 is relatively easy since most unix-like systems come with python pre-installed, however you should know the dependencies before installing this software.

Dependencies

python 3+
python 3 pip
pip markdown module for python 3
sortedcontainers module for python 3

Optional software

Installation steps

Download this repository as a zip file or tarball. If you have git installed, you can run the following command to clone the repo: git clone https://codeberg.org/nokoru/nci2
Once you cloned the nci2 repository, install it by entering the directory where the nci2 source is in (cd nci2) and run ./install.
Wait for the installation to be completed. If the there are missing dependencies, the installation script will try to install them, however, keep in mind that this auto-installation of dependencies only works on some systems (Ubuntu, Mint, Debian-based distros and a few others)
Run nci about to check if nci2 was successfully installed.

nci2 wasn't installed?

Please install the dependencies. Assuming that only the markdown module is missing, run pip3 install markdown to install it.

If you can't run the installation script, run chmod +x install to make the script executable, then run ./install and there shouldn't be any problems.

If you still can't install nci2, please submit an issue to get help.

Installing nci2 on Windows

I don't know if nci2 may work on Windows. If you can make it work properly on Windows, please tell me and I'll add the steps to install nci2 on Windows. You can also submit a pull request if you want to help documenting the steps to follow.

Getting Started

Create a directory for your blog and open it. Example: mkdir my_neocities_blog && cd my_neocities_blog
Run nci init
Answer a few questions that nci will ask you in order to work properly
Congratulations! You just initialized nci2 in the directory of your website!

For more information about how to use the software, run nci help or read the wiki.

I already have a website and I don't want to lose my files

Follow all the steps above.
Run nci pull to download your website files from neocities.

Disclaimer

nci2 is a hobby project made by me (nokoru). I won't be responsible for damages to your website caused by the misuse of this program.

Donations

Please donate to neocities if you can. It's a wonderful project. ❤️

Credits & License crap

Original nci2 by nokoru <nokoru@disroot.org> (chat/xmpp and e-mail)

nci2 is public domain software (license: Unlicense), so do whatever you want with it. Use it and adapt it to your needs. It'd be nice if you shared your modifications with other users, so everyone benefits :3

README.md 4.5 KB 永久連結 文件歷史 原始文件