Giter VIP home page Giter VIP logo

galenframework.com's Introduction

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

galenframework.com's People

Contributors

ishubin avatar hypery2k avatar andyjack avatar elgalu avatar janenechytailova avatar nidhimj22 avatar maccracken avatar tillsc avatar timoreimann avatar

Watchers

James Cloos avatar Dao Minh Dam avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.