All Projects → kaustavha → Luvit Docs

kaustavha / Luvit Docs

Documentation for the luvit api

Labels

Projects that are alternatives of or similar to Luvit Docs

Seafile Openwrt
A port of Seafile for OpenWrt 14.07
Stars: ✭ 19 (+171.43%)
Mutual labels:  makefile
Erlang Starter Kit
Provide a basic set of Erlang/OTP tools for development and for testing
Stars: ✭ 23 (+228.57%)
Mutual labels:  makefile
Wordpress Starter
📦 A starter template for WordPress websites
Stars: ✭ 26 (+271.43%)
Mutual labels:  makefile
Distributiontests
Swift 3 distribution test for open-source libraries.
Stars: ✭ 22 (+214.29%)
Mutual labels:  makefile
Tlsconfigguide
Configuration templates for configuring TLS
Stars: ✭ 23 (+228.57%)
Mutual labels:  makefile
Buildroot Submodule
Example of use of buildroot as a submodule
Stars: ✭ 24 (+242.86%)
Mutual labels:  makefile
Network Programming With Go
Network programming with Go
Stars: ✭ 903 (+12800%)
Mutual labels:  makefile
Malloc trim
Gives some ruby memory back to the OS
Stars: ✭ 27 (+285.71%)
Mutual labels:  makefile
Bbb Buildroot Fwup
Example project showing how to use buildroot and fwup
Stars: ✭ 23 (+228.57%)
Mutual labels:  makefile
K8s Clusters
Simple kubernetes clusters on cloud providers for development
Stars: ✭ 26 (+271.43%)
Mutual labels:  makefile
Aws Vault Alfred Workflow
Alfred workflow to Open AWS in your browser via aws-vault
Stars: ✭ 23 (+228.57%)
Mutual labels:  makefile
Busybox
Prometheus Busybox Docker base images
Stars: ✭ 23 (+228.57%)
Mutual labels:  makefile
Unity3d
Link to article
Stars: ✭ 25 (+257.14%)
Mutual labels:  makefile
Aospbuild
Stars: ✭ 22 (+214.29%)
Mutual labels:  makefile
Slim Php Docker Starter
Starter for a dockerized Slim Framework application
Stars: ✭ 26 (+271.43%)
Mutual labels:  makefile
Openwrt Dvb
OpenWrt feed focused on DVB applications
Stars: ✭ 19 (+171.43%)
Mutual labels:  makefile
Ansible Docker Compose
Ansible Role which installs docker-compose
Stars: ✭ 24 (+242.86%)
Mutual labels:  makefile
Traj gen vis
auto_chaser project
Stars: ✭ 27 (+285.71%)
Mutual labels:  makefile
Makefile Template
A generic makefile template
Stars: ✭ 26 (+271.43%)
Mutual labels:  makefile
Rabbitmq Metronome
RabbitMQ example plugin
Stars: ✭ 25 (+257.14%)
Mutual labels:  makefile

Luvit Documentation

Much needed docs for Luvit. The build system and scaffolding is straight up ripped out of node.js.
Therefore you will need node.js installed to make these docs.

  • Clean generated documentation -> make docclean
  • Generate documentation -> make doc
  • Open docs in Chrome on OSX or Linux -> make docopen

Simply running make will run the above tasks in the specified order.

Todo

These docs are a skeleton at the moment. My goal is to begin by at least indexing the functions available to Luvit users to save a little time reading through the source code.
PRs, suggestions, issues, bug/mistake reports are very welcome.

  • Add more code examples (There's some examples in the luvit repo under examples)
  • Expand on method/class/func defintions and their purposes
  • Change code rendering from js to lua
  • Rewrite doc generation pipe in lua/luvit?
Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].