____ /\ _`\ \ \ \/\ \ ___ ___ ___ ___ \ \ \ \ \ / __`\ /'___\ /'___\ / __`\ \ \ \_\ \ /\ \ \ \ /\ \__/ /\ \__/ /\ \ \ \ \ \____/ \ \____/ \ \____\ \ \____\ \ \____/ \/___/ \/___/ \/____/ \/____/ \/___/ Docco is a quick-and-dirty, hundred-line-long, literate-programming-style documentation generator. For more information, see: http://jashkenas.github.com/docco/ Installation: sudo npm install -g docco Usage: docco [options] FILES Options: -h, --help output usage information -V, --version output the version number -l, --layout [layout] choose a built-in layouts (parallel, linear) -c, --css [file] use a custom css file -o, --output [path] use a custom output path -t, --template [file] use a custom .jst template -e, --extension [ext] use the given file extension for all inputs -L, --languages [file] use a custom languages.json -m, --marked [file] use custom marked options
Literate Programming can be Quick and Dirty.
Overview
Comments
-
Added support for a few basic options
- Added
--version
- Persist folder structure in docs dir via
--structured
(solves #38)- Will be very useful on larger projects or for users that have multiple src folders
- Necessary to doc similarly named files in different folders
- Ability to include styles inline via
--inline
- This could be useful for sharing a specific src file doc w/out the whole docs folder
- Avoids link path issues when
--structured
option is used
- Use custom stylesheet via
--css fileName.css
-c
is an alias for--css
- Use custom template via
--template fileName.jst
-t
is an alias for--template
Docco defaults are retained; these are additional features and should not affect the basic (quick-and-dirty) use-case.
- Added
-
Basic responsive layout template and CSS
This is related to issue #80
I replaced the table layout of the page with a list of sections, and styled them appropriately.
The CSS is designed for low-resolution up media queries. The base set of styles are for the low-res screen and they stack documentation on top of code.
Take a look (on a mobile device maybe?) : http://justindujardin.github.com/docco/
-
Support for recursive dirs
You can generate docs that mirror your directory structure by calling
docco dir/
. The standard behavior ofdocco some.file
ordocco dir/*
is preserved, to avoid breaking current users (if you had a dir in the list of sources, 0.3.0 blows up).This hopefully satisfies #38. Also, it is hopefully a more straightforward way than
--structured-output
in #45 (Since most of the usage out there seems to be about generating docs along side asrc/
orlib/
dir, rather than inside it). -
Quick and (not so) dirty tests, command line options, and public API
I love docco, and use it on a regular basis for my projects. I really wish it was a little less 'dirty' without being much more complex, so here are some changes to make that a reality. I've tested them pretty thoroughly, and taken care to document what was changed.
Goals
- Keep
docco.coffee
as concise as possible. - Add flexibility, with testing to verify that it works as intended.
- Keep the changes easy-to-review and non-controversial.
Reviewing
To make sure that these changes are easy to review, I've updated my gh-pages branch to reflect them, and made it easy to run the test suite.
View the documented source and tests
Most of the relevant changes start here : http://justindujardin.github.com/docco/#section-17
And, of course, the tests: http://justindujardin.github.com/docco/tests.html
Run the tests
git clone [email protected]:justindujardin/docco.git cd docco/ npm install . cake test
Changes
- Install CoffeeScript, Showdown.js, and Commander.js via NPM package dependencies.
- Add public API so that docco can be require'd and used programatically.
- Add options for custom output path, jst template, and css file to use.
- Add simple test runner (borrowed from CoffeeScript), and tests for new (and old) functionality.
- Add a
README.md
to theresources
directory, explaining the templates it contains. (https://github.com/justindujardin/docco/tree/master/resources) - Add
pagelet.jst
andpagelet.css
to theresources
directory, which output inline HTML for use in an existing DOM page. - Add
cmd.coffee
for development use (to invoke docco.coffee from the command line.) - Update binaries and documentation.
Usage Help
By using commander.js for command line option parsing, docco gets automatically generated usage information:
$ docco Usage: docco [options] <file_pattern ...> Options: -h, --help output usage information -V, --version output the version number -c, --css [file] use a custom css file -o, --output [path] use a custom output path -t, --template [file] use a custom .jst template
- Keep
-
Support for mult-iline/here comments in JavaScript
docco now parses block comments in JavaScript code. This allows you to use natural docs style commenting but still generate docco html. Example:
https://gist.github.com/1440633
-
Support multiple files with the same name.
Fixes #223.
Previously, if two or more files had the same base filename only one would be documented. The others would be overwritten.
This patch replicates the structure of the source tree in the document output tree to allow source files with the same name but different paths.
-
Can't run Docco with JavaScript
Environment: OS: ArchLinux Node: v0.6.6 npm: v1.1.0-beta-4
I installed docco through npm. When I tried to run
docco test.js
, I received the following error:node.js:201 throw e; // process.nextTick error, or 'error' event on first tick Error: write EPIPE at errnoException (net.js:632:11) at Object.afterWrite [as oncomplete] (net.js:470:18)
Even after installing python-pygments (
sudo pacman -S python-pygments
), the error is still there.Only a css file is generated in docs folder.
question -
Switch to marky-markdown?
Does everyone think it's ok to switch to
marky-markdown
for markdown parsing in some later version of docco?There are multiple issues with the
wontfixmarked
module that don't seem to be getting fixed. Like nested lists not working. I was thinking of trying a PR tomarked
, but I saw all the old pull requests, and thought nah. -
Add multi-line support.
This commit adds support for multi-line comments with the minimal set of changes while still being compatible with most languages. The one obvious exception is single-line /* */ style-comments in C-style languages.
Derived from https://github.com/jashkenas/docco/pull/72
enhancement -
Fresh configuration
Now, each time the
configure
function is calledconfig
is wiped and extended upon using the default configuration along with that provided by either programmatically or via the CLI.I'm hoping this should fix #165 and prevent any further related bugs appearing.
-
Not working in Windows 7
I've been trying to get Docco working on Windows 7. I have the latest version of Node.
I tried using the following tutorial: http://bateru.com/news/2012/03/how-to-install-docco-on-windows-7/
Following everything apart from the Paths. I only added the python paths ';C:\python27;C:\Python27\Scripts;' since Node is already available from the command line.
Everything installs but when I try to use docco, I get
Error: ENOENT, no such file or directory 'c:\Users\user\Downloads\docco\docs\docco.css'
bug fixed -
CLI css, template, and marked options not honored.
Some debugging reveals that these properties on the
options
object are alwaysundefined
, even if the CLI options were passed.I was about to submit a PR, but someone else already has: https://github.com/jashkenas/docco/pull/422edit: Nevermind, that PR only updated the .litcoffee file, not the JS file that is actually executed.
-
Upgrade the package-lock.json to v2
This is the lockfile format that comes with npm v7 and npm v8. It is ostensibly compatible with older versions of npm.
When I ran
npm install
in order to work on #422, this upgrade happened automatically; I decided to submit the change in a separate PR. -
Adjust the configure function to commander v8
As of commander v8, the options are no longer present on commander itself; they are only available through commander.opts().
Without this change, the options
template
,css
andmarked
are ignored in Docco 0.9+. I discovered this while trying to recompile the annotated sources of Underscore.@jashkenas Note that I did not yet recompile the
docco.js
. -
Add another "partner in crime"
Hi there!
Due to this project's (somewhat surprising, given its age) recent popularity on HN, I've become interested in writing yet another clone, this time in awk. Here's the website for what I'm calling DOC AWK:
https://acdw.casa/docawk/
Feel free to include it in your list!
-
fix marked dependency (#417)
Hey—I want to write a tutorial about extending the Controller class for lil-gui and I remembered this classic lib...
I just changed the
marked
dep to the oldest version that doesn't have a vulnerability warning and docco is generating docs again. Tried italicizing something, seems like markdown is still working as well. This is on the latest node 16.13.
JavaScript documentation generator for node using markdown and jsdoc
Dox Dox is a JavaScript documentation generator written with node. Dox no longer generates an opinionated structure or style for your docs, it simply
Learn, design or document codebase by putting breadcrumbs in source code. Live updates, multi-language support and more.
What · Demo · Get started · Features · Case studies · Support What Have you ever got lost in a big or unknown codebase? This tool will help you to sol
Pointers to useful, well-written, and otherwise beautiful documentation.
DO YOU WANT TO BUILD AND WRITE GLORIOUS TECHNICAL DOCUMENTATION FULL TIME? EMAIL [email protected]. WE NEED YOU. Beautiful Docs I love documentation. If
A TypeScript/JavaScript library for working with ASN, IPv4, and IPv6 numbers. It provides representations of these internet protocol numbers with the ability to perform various IP related operations like parsing, validating etc. on them
ip-num ip-num is a TypeScript library for working with IPv4, IPv6 and ASN numbers. It provides representations of these internet protocol numbers with
Tsailun - open source online document and collaboration
Open source selfhosted web-based wiki/doc/knowledge management and collaboration
This bot was made for legal reasons and testing , i don't take responebilty about anything you do with it. There is a high chance your bot is getting banned if you use this package so please use discord bots that is over 3 months old.
About The bot This bot was made for legal reasons and testing , i don't take responebilty about anything you do with it. There is a high chance your b
dexy 2.2 1.9 L4 Python is a free-form literate documentation tool for writing any kind of technical document incorporating code.
Dexy Dexy is open source automation software with features especially designed for documentation and reporting. More information at http://dexy.it Doc
THE PROJECT IDEA is to create a platform where developers can improve on their typing speed and accuracy by playing a coding typing game in their preferred programming language, which will make developers both beginners and pros get more familiar with the syntax of their programming languages.
Typing Game for Developers to Boost their Typing Speed and Accuracy Read Blog Technologies Yarn React JS Html Css Features ?? Typing Area ?? Ranking ?
BestBuy Bot is an Add to cart and Auto Checkout Bot. This auto buying bot can search the item repeatedly on the ITEM page using one keyword. Once the desired item is available it can add to cart and checkout very fast. This auto purchasing BestBuy Bot can work on Firefox Browser so it can run in all Operating Systems. It can run for multiple items simultaneously.
BestBuy Bot — Open Source GPU/PS5/Xbox Bot I took bits from best open and closed sourced bots and made this simple bot. Please star my repo if this co
This a programming training app, aimed to help OMRI's students learng the magic world of programming.
OMRI App (fe-omri-app) This a programming training app, aimed to help OMRI's students learng the magic world of programming. Install the dependencies
When a person that doesn't know how to create a programming language tries to create a programming language
Kochanowski Online Spróbuj Kochanowskiego bez konfiguracji projektu! https://mmusielik.xyz/projects/kochanowski Instalacja Stwórz nowy projekt przez n
Cookbook Method is the process of learning a programming language by building up a repository of small programs that implement specific programming concepts.
CookBook - Hacktoberfest Find the book you want to read next! PRESENTED BY What is CookBook? A cookbook in the programming context is collection of ti
Notices on a digital platform are quick and easy to access, reduce a lot of paper waste, and one can get notified about the updates and news.
DigitalNoticeBoard - Mobile App - (Still In DEV) An Notice Board App for Students To Stay Connected With The College Updates..! Why a college campus n
microregex is an open source and highly curated catalog of regular expression patterns. It offers programmers RegEx snippets that can be quickly exported into a variety of programming languages and distributed around teams.
microregex - A catalog of RegEx patterns View Demo · Report Bug · Request Feature Loved the tool? Please consider contributing ✍️ to help it improve!
Welcome to the LEGO Games Repository, where you can enjoy anytime, anywhere. This is the 2021 KNU Advanced Web Programming team project.
Welcome to LEGO git repository! Here are some useful information about LEGO service. 0. Docker image Link : https://hub.docker.com/r/leibniz21c/legoga
This is a project by members of the KalleTech discord server. We are making a website where you can practice your programming speed.
codetyper This is a project by members of the KalleTech discord server. We are making a website where you can practice your programming speed. Links W
JIT Compiler is a open source online code compiler. You can run more than 40+ most popular programming languages in your browser just-in-time using jitcompiler.
JIT Compiler is a open source online code compiler. You can run more than 40+ most popular programming languages in your browser just-in-time using jitcompiler.
This is a boilerplate for creating your own languages for various use cases. You can even create your own programming language from scratch!
Bootstrap compiler This is a bootstrap compiler that can be used to compile to compiler written in the target language. You can write a compiler in th
A quick and easy to use security reconnaissance webapp tool, does OSINT, analysis and red-teaming in both passive and active mode. Written in nodeJS and Electron.
ᵔᴥᵔ RedJoust A quick and easy to use security reconnaissance webapp tool, does OSINT, analysis and red-teaming in both passive and active mode. Writte
The Space Traveler's Hub is an application where users can check out availble space rockets and book them or cancel the previously made booking. Also users can find a list of current missions along with their brief description and can join the selected mission or leave the mission the user joined earlier.
Space-Travelers-Hub The Space Traveler's Hub is an application where users can check out available space rockets and book them or cancel the previousl