Comments (8)
oh, yesterday I was a little busy for my work.
I will have 8 days off from 10.1 to 10.8 (October).
Maybe we can 'talk' about vuepress-plugin-docgen.
actually I'm not good at English... I afraid I can't understand the all meaning of your word.
I always use Google translate.
If I'm better at English, I would like to talk with you~
I can use WeChat, record , or online meeting ,or something else.
I really want to make easier for creating Components Document.
from vuepress-plugin-docgen.
Do you have any feature or TODO list ?
I'm interested about the plugin.
Maybe I could do something to make the plugin better ~
from vuepress-plugin-docgen.
Hello @zhaozhe0831 thanks for appreciate my plugni :). I don't have much time to take care of it yeah ...
But in my todo list ii wanted to dooo:
- upgrade to last vuepress
- improve design
- add initernationalisation
- hot or hard reload when change is done in dev
If you want to work on it tell me I can add those tasks and assign them to you and I will try to help you as much as possible for sure
from vuepress-plugin-docgen.
- upgrade to last vuepress
- improve design
- add initernationalisation
- hot or hard reload when change is done in dev
Isn't it support the latest vuepress now? your mean Vue 3.0 version ?
initernationalisation?I think maybe I can help chinese version
from vuepress-plugin-docgen.
Maybe I could add feature.
allow user DIY components introduction page.
we can let user introduce their components in here.
to parser a README.md in src/components/README.md
for the introduction.
what do you think about my opinion ? If you think ok, I'll do it in my free time.
from vuepress-plugin-docgen.
Yes, upgrade the version I am using i didn't test on the last vuepress if my plugins are working. I stopped working with vuepress core team for a while I have to admit.
Internationalization is when you want to use i18n for the documentation. But it's not the most important feature I think.
What do you mean by DIY. I have like template already
https://f3ltron.github.io/vuepress-plugin-docgen/guide/more.html#additionalpages
Tell me if it's what you are speaking about. But with that, you can override the default template rendering function and add yours. Maybe there is a lack of documentation on this
from vuepress-plugin-docgen.
You mean the home page. I would have to check about it but normally you can override the introduction page of components too with the index or with a readme. Not 100 % sure.
And of course don't hesitate to ask I will try to guide you about the knowledge of the plugin! It's really cool to see more people using it
from vuepress-plugin-docgen.
Thank you!
from vuepress-plugin-docgen.
Related Issues (20)
- in the globalContext we should use globs or having exclude folder/files
- bad url HOT 3
- introduction template could be improve
- events template could be improve
- methods template could be improve
- props template could be improve
- slots template could be improve
- tags template could be improve
- inside a component import from relative path is working
- default examples can be improve and more documented
- [DEV] we need to fully integrate the dev environement to vuepress HOT 1
- Hot Module reload when changing a documentation HOT 5
- Annoying Console log to be removed
- Components pages content div does not have the right class HOT 1
- Multiple Component Directories HOT 7
- IMPORTANT INFORMATIONS | I JOINED VUEPRESS CORE TEAM HOT 1
- Need feedback. Should we consider wrapping a component into an iframe? HOT 3
- Any vuepress plugin should start with `vuepress-plugin-` HOT 1
- Use lerna for better scaffolding
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 vuepress-plugin-docgen.