angularclass / dope-docs Goto Github PK
View Code? Open in Web Editor NEW:lipstick: :green_book: Storybook inspired UI docs generation for your Angular projects
:lipstick: :green_book: Storybook inspired UI docs generation for your Angular projects
RIght now, there is no way to theme the docs. All changeable css is written in TypeScript so if can be changed
Trying to install with Yarn:
/home/ivan/new-site-angular [master ● ] $ yarn add @angularclass/dope-docs
yarn add v0.24.4
[1/4] Resolving packages...
error An unexpected error occurred: "https://registry.yarnpkg.com/@angularclass%2fdope-docs: Not found".
info If you think this is a bug, please open a bug report with the information provided in "/home/ivan/new-site-angular/yarn-error.log".
info Visit https://yarnpkg.com/en/docs/cli/add for documentation about this command.
Trying to install with npm:
/home/ivan/new-site-angular [master ● ] npm install @angularclass/dope-docs
npm ERR! Linux 4.10.15-200.fc25.x86_64
npm ERR! argv "/usr/bin/node" "/usr/bin/npm" "install" "@angularclass/dope-docs"
npm ERR! node v6.10.2
npm ERR! npm v3.10.10
npm ERR! code E404
npm ERR! 404 Not found : @angularclass/dope-docs
npm ERR! 404
npm ERR! 404 '@angularclass/dope-docs' is not in the npm registry.
npm ERR! 404 You should bug the author to publish it (or use the name yourself!)
npm ERR! 404
npm ERR! 404 Note that you can also install from a
npm ERR! 404 tarball, folder, http url, or git url.
npm ERR! Please include the following file with any support request:
npm ERR! /home/ivan/new-site-angular/npm-debug.log
Write now, the dope docs only cater to UI elements. Would be nice to add docs for things like services and such.
All docs are just listing in the nav in the order they are loaded. Would be nice to group them by a common key like:
form stuff
input
icon input
button
layout stuff
list
table
We need to let the user know where their stuff is being served.
Hi,
I follow the readme file and Im not sure how to see the result
I added the dope.js file to the root then
I added the dope-docs. into the './src/dope-docs.ts' and update to the relevant ngModule
I added button.doc.ts
now what I dont understand is how and where I should see the result
BTW i'm using the latest angular cli
Thanks
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.