idanbauer / ngdocs Goto Github PK
View Code? Open in Web Editor NEWa way to document Angular Projects
a way to document Angular Projects
Hi!
We found an issue where for example we have the following directives:
test-de-one
test-de-one-two
test-de-one-two-three
After typing in 'test-d' on the search box provided, it will filter the list but will only show:
test-de-one
test-de-one-two-three
I am trying to find a pattern to it but I am unsuccessful.
For example,
@decorator
class X {}
Above code snippet won't work and the document being generated will stop parsing once it gets to the `@' character.
I suspect that it should be something with the fact that '@' is used to specify ngdoc comments like @ngdoc directive
.
docsconfig.json:
{
"outputDir": "tmp/docs",
"apiDir": "app/assets/javascripts"
}
Ran ngdocs
[~/code]> ngdocs
Generating Documentation...
Process ran > 9 minutes without writing any files
[~]> ps -ef | grep ngdocs
501 14704 14609 0 2:42PM ttys008 0:00.00 grep ngdocs
501 13425 642 0 2:33PM ttys009 8:45.81 node /usr/local/share/npm/bin/ngdocs
Folders are empty so far.
[~/code]> tree tmp/docs
tmp/docs
└── partials
DOS carriage return newlines \r\n
cause OSX to choke on trying to run node\r
.
[~/code]> ngdocs
env: node\r: No such file or directory
node\r
the \r
being the problem.
dos2unix the files or replace \r\n
with \n
for OSX compatibility.
Hi,
I am contributing with your project creating snippets for Sublime Text!
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.