Skip to content

galenframework/galenframework.com

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Galen Framework

This is the source code of the generated GalenFramework.com website. It is powered by Blogix which is a static website generator with embeded webserver. If you would like to contribute to Galen Framework documentation like adding information or fixing errors please follow the steps below:

  1. Get blogix and configure it. This is described in Blogix Documentation
  2. Make a change. All the source pages for documentation are located in db/docs/ folder and have the .blogix file type
  3. Run blogix run command within root folder of the project and it will launch the local webserver so you can test your changes via http://localhost:8080.
  4. Send a pull request. I will review it and make an update on a live site.
  5. Thank you!

P.S. At the moment the blogix is not really supported so if it doesn't work for you just send your changes as is. I can't spend time on so many projects so I decided not to maintain blogix as it just works for me (with few minor bugs). But if you do manage to set it up please note that during local testing all the urls should end with slash (/). e.g. http://localhost:8080/docs/all/. If you remove the last slash it will give you an exception.

Check spelling with aspell

aspell is available on many systems. Alternatively, you could use the .stopwords file with your own spell-checking program.

# Create a local dictionary first
aspell --lang=en create master ./.stopwords.aspell < .stopwords

# Check e.g. docs/about.blogix.
# Repeat for other docs/*.blogix files
aspell check --lang=en_US --add-extra-dicts=./.stopwords.aspell docs/about.blogix