This repository has been archived by the owner. It is now read-only.
A dirty and quick documentation generator
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs
README.md
arcco.lua
luabalanced.lua
markdown.lua
template.lua

README.md


Arcco

Arcco is the son of Locco and grandson of Docco, Powered by Marker.js is a part of Docco family that educated in Arendelle Language and with a great passion he is your quick-and-dirty documentation generator. It produces an HTML document that displays your comments intermingled with your code. All prose is passed through Markdown, The whole website is then connected to the Marker.js script so you can have beautiful Arendelle codes.

Meet the family:

Arcco comes from a really huge families in the computing world! You see Arcco's origin goes to Docco and then to Locco as it's based on the original source code of Locco which is based on Docco, However there are many fellas in the family, Let's meet em:

  • Docco: The beloved grandpa by Jeremy Ashkenas. He's maybe the oldest and wisest one in the family.

  • Locco: Locco is a the true father of Arcco, If you make a DNA test you'll probably get a 95% similarity because Arcco actually is Locco! It's cool less than a hundred code for Lua by Lua! So thank you Robert Gieseke

  • Rocco: One of the Tomayko family's gentlemen. He's native language is Ruby because of his father Ryan Tomayko

  • Shocco: Also from the Tomayko family. He wanted to be a little bit more technical so he went to the Shell University and graduated in the Bash scripting.

  • Pycco: Pycco is wild because he's a python! So if you love Pythons, You have so much in common! Thanks to Nick Fitzgerald for that.

  • Clojure: Who loves Clojure? You do! Who loves Clojure? You do! So just get on your feet and use it! Also keep in mind that it's pretty code by Gary Deer

  • Gocco: Gocco is one of those modern oldies, He's DNA full of Go! Written by Nikhil Marathe it's your tool if you're a Go-man!

  • PHP: I personally never liked PHP and also the idea of not using docco style names, However Fredi Bach really has something there, His system has line numbers and a pretty different look worth of looking!

  • Nocco: Nocco is our Christophe Colomb! He is the one who dared to go to the strange world of Windows and it's .NET! So I know that I heart for C# so Nocco is a dear friend to me! Thank you so much Don Wilson

Licensing

Copyright (c) 2015-2016 Kary Foundation, Inc.
   Author: Pouya Kary <k@karyfoundation.org>
Arcco is based Locco which is then based on Docco, 
released under the following license:
Copyright (c) 2011-2014 Robert Gieseke
Locco is based on Docco, released under the following license:
Copyright (c) 2009-2013 Jeremy Ashkenas

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.





Copyright (c) 2011-2014 Robert Gieseke
Locco is based on Docco, released under the following license:
Copyright (c) 2009-2013 Jeremy Ashkenas

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.





Copyright (c) 2009-2015 Jeremy Ashkenas

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.