Comments (3)
Sure, documentation for NgDoc was created via NgDoc, so you can do the same using this library, write guides, create demos and automatically generate documentation for your API based on your code comments and it will look like this - https://ng-doc.com/
from ng-doc.
I'm currently working on the landing page that will demonstrate the process of creating documentation, some advantages, features etc.
Also here is the video demonstration of writing guides that you can check
And you can play with it on a stackblitz
from ng-doc.
I am closing this ticket, because now a landing page is available on which you can see an example of use.
from ng-doc.
Related Issues (20)
- Support for native i18n / $localize + localized markdown HOT 3
- [Feature] Demo Pane viewport and theme support
- [Feature] Custom Tabs in Demo HOT 5
- [Feature] Display Component Properties in Component Tabs and on Page HOT 1
- [Bug] Configure Home icon route path of breadcrumb
- Add plugin for customizing the transformation of markdown to HTML
- [Query] Usage of Snippets
- [Bug] Support angular17html in code fences HOT 2
- [Feature] Support inline template syntax highlighting HOT 2
- [Query] Usage of Recreate option in the Playground HOT 2
- [Bug] API Link Reference missing for optional properties of a component HOT 2
- [Feature] Customising Playground HOT 2
- [Feature] Add possibility to provide custom properties for custom sidebar HOT 2
- [Query] What is ```twig fence code and what all the markdown fence code supported in Ng Docs? HOT 3
- [Feature] Add tabs for common macros and Angular components to display their usage variations along with previews
- Demo/Demo Pane Crash with "Unexpected end of JSON input" [Bug] HOT 4
- [Bug] Build / serve crash when using Angular 18.1 HOT 9
- [Bug] Anchor seems not working with french accents HOT 3
- [Bug] "Octal escape sequences are not allowed" validation error using generated demo-assets code HOT 1
- [Bug] 17.6.15 Build failed HOT 6
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from ng-doc.