Giter VIP home page Giter VIP logo

Comments (8)

zhaozhe0831 avatar zhaozhe0831 commented on June 20, 2024 1

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.

zhaozhe0831 avatar zhaozhe0831 commented on June 20, 2024

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.

flozero avatar flozero commented on June 20, 2024

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.

zhaozhe0831 avatar zhaozhe0831 commented on June 20, 2024
  • 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.

zhaozhe0831 avatar zhaozhe0831 commented on June 20, 2024

Maybe I could add feature.

allow user DIY components introduction page.

image

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.

flozero avatar flozero commented on June 20, 2024

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.

flozero avatar flozero commented on June 20, 2024

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.

zhaozhe0831 avatar zhaozhe0831 commented on June 20, 2024

Thank you!

from vuepress-plugin-docgen.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.