LiaScript / CodiLIA

CodiMD - Realtime collaborative markdown notes on all platforms.

CodiLIA

CodiLIA lets you collaborate in real-time to create interactive online courses with LiaScript. Built on HackMD source code, CodiLIA lets you host and control your course content with speed and ease.

Free (Test)-Deploy

Click on the button below and follow the install-instructions.

There are two parameters that you might set during the installation on heroku:

• CMD_SHARE_URL: If you want to use LiaScript website as the target-website for publishing you can set this parameter to

  https://LiaScript.github.io/course/?https://YOURAPP.herokuapp.com

  If you leave this out, your courses will be published locally...

• CMD_RESPONSIVEVOICE_KEY: get a key that fits to your target-projects from https://responsivevoice.com

HackMD

HackMD helps developers write better documents and build active communities with open collaboration. HackMD is built with one promise - You own and control all your content:

• You should be able to easily download all your online content at once.

• Your content formatting should be portable as well. (That's why we choose markdown.)

• You should be able to control your content's presentation with HTML, slide mode, or book mode.

CodiMD - The Open Source HackMD

CodiMD is the free software version of HackMD, developed and opened source by the HackMD team with reduced features (without book mode), you can use CodiMD for your community and own all your data. (See the origin of the name CodiMD.)

CodiMD is perfect for open communities, while HackMD emphasizes on permission and access controls for commercial use cases.

HackMD team is committed to keep CodiMD open source. All contributions are welcome!

CodiLIA - CodiMD for writing LiaScript

CodiLIA allows you to write free and open online courses based on an extended Markdown syntax. It applies the CodiMD backend, but all Markdown is interpreted by LiaScript. You can either share your courses from your plattform or share it via https://LiaScript.github.io

Type lia into the editor to get help on common liascript tasks and functionality._

Documentation

You would find all documentation here:

LiaScript Documentation

CodiMD Documentation

Deployment & Co

To try this out locally, you need to clone this repository and build it via:

git clone https://github.com/LiaScript/CodiLIA
cd CodiLIA
npm i
npm i sqlite3
bin/setup
npm run build
npm run start

and then open your browser at http://localhost:3000/

With Docker:

cd deployments
docker-compose up

Change the configuration in docker-compose.yml. It will automatically download the latest CodiLIA version. If you want to share your course, you have to set the CMD_SHARE_URL parameter in this file accordingly.

Also checkout https://responsivevoice.com and get a free key. This key can be used with CMD_RESPONSIVEVOICE_KEY to enable text to speech output for your editor.

All the other parameters are CodiMD-parameters, see the CodiMD Configuration.

If you want to, you can build your own docker-container by running the following commands:

cd docker-helper
make
cd ..
cd deployments
./build.sh

Further information:

If you want to spin up an instance and start using immediately, see Docker deployment. If you want to contribute to the project, start with manual deployment.

Configuration

CodiMD is highly customizable, learn about all configuration options of networking, security, performance, resources, privilege, privacy, image storage, and authentication in CodiMD Configuration.

Upgrading and Migration

Upgrade CodiMD from previous version? See this guide

Migrating from Etherpad? Follow this guide

Developer

Join our contributor community! Start from deploying CodiMD manually, connecting to your own database, learn about the project structure, to build your changes with the help of webpack.

Contribution and Discussion

All contributions are welcome! Even asking a question helps.

Project	Contribution Types	Contribution Venue
CodiMD	👫 Community chat	Gitter
	🐛 Issues, bugs, and feature requests	Issue tracker
	📚 Improve documentation	Documentations
	📝 Translation	POEditor
	☕ Donation	Buy us coffee
HackMD	❓ Issues related to HackMD	Issue tracker
	✏️ Translation	hackmd-locales

Browser Support

CodiMD is a service that runs on Node.js, while users use the service through browsers. We support your users using the following browsers:

• Chrome >= 47, Chrome for Android >= 47
• Safari >= 9, iOS Safari >= 8.4
• Firefox >= 44
• IE >= 9, Edge >= 12
• Opera >= 34, Opera Mini not supported
• Android Browser >= 4.4

To stay up to date with your installation it's recommended to subscribe the release feed.

License

License under AGPL.