vemsy v0.2.0

Vemsy

What is it ?

When coding, it is for me mandatory to write files with a limited number of lines and functions as well as 1 file >= 1 functionality.

The question now is why would I not impose the same rigor when writing a text / documentation about some subjects.

Rich text editor

Normally to do such thing, I use a rich text editor (such as Microsoft Word), write a summary, with a lot of sub-subject in it. When doing that at some points they are subjects difficult to categorize to put in your section x page 10 or you section y page 30, that the moment when I realize splitting the document might be interesting. Another use case that might appear is when you have repeated category of subject with the same sub-section, and sub-sub-sections... splitting it in multiple files is more interesting.

CMS

In case I want to write something bigger, with more people working on it, I will probably chose to use a CMS. This will allow me to write different types of content with some of the most used features of a Rich Text Edition thanks to WYSIWYG. This gives the possibility to a very details roles permissions to handle all kind of contributors of your project.

Th downside of it, is when you want new type of content, you will need developer to release your new type of content even if no specific features are needed aside adding some fields with no dependency between contents. When you chose a CMS, you will have to think about your database, the charge your website can handle, if you need cache on your webpage ... and so one.

How vemsy try to solve most of those issues

Vemsy is a static website with the possibility to add features on it. Because it is a static website no database are needed, the content is written in markdown files.

For those need Markdown solve most of them specially if you customize a little the css or use some that was done by other Ex: markdown-css-themes

Features

The list of all the features currently available:

• Render markdown files following folder structure
• Task loading setup
• Add your own express middlewares
• Theme
• Route based feature / customization (Page, Template)

How to use it

Unfortunately, there is no boilerplate available for the moment. Instead you can copy the example folder

The entry point defined all the tasks loader that will be executed to set up the application.

I want to know more

The technical documentation is filled in the example folder: ./example/app/contents/ If you execute the example the documentation is available through a vemsy server on http://localhost:1337