Ultrabenosaurus / FicToc

Automatic Table of Contents for your amateur fiction!

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

FicToc

Automatic Table of Contents for your writing project!

FicToc aims to make it easy for you to keep your amateur (or professional) writing project! Inspired by my frustration at WordPress-using translation projects and amateur fiction writers not updating project ToCs in a timely fashion, I decided to make a plugin that handles most of it for you.

Development

I'm using VCCW to work on this, which is a great Vagrant box designed specifically for WordPress development.

If you already use Vagrant with VirtualBox, just vagrant up and hit fictoc.dev in your browser of choice (you might need to add vccw.dev 192.168.33.10 to your hosts file, especially on Windows) to get a look at the plugin running in its current state.

If you don't have Vagrant, chances are you probably don't even know what it is. Go hit up their website and see if it's something you're comfortable playing with, and if so follow the VCCW instructions to get their environment set up. If you don't think it's something you're okay to play with then you'll need to figure out on your own how to integrate my code with your development environment.

License

As usual with my work, this project is available under the BSD 3-Clause license. In short, you can do whatever you want with this code as long as:

  • I am always recognised as the original author.
  • I am not used to advertise any derivative works without prior permission.
  • You include a copy of said license and attribution with any and all redistributions of this code, including derivative works.

For more details, read the included LICENSE.md file or read about it on opensource.org.

Top

About

Automatic Table of Contents for your amateur fiction!

License:BSD 3-Clause "New" or "Revised" License


Languages

Language:HTML 54.3%Language:Ruby 43.7%Language:Shell 1.8%Language:Perl 0.1%