Giter Site home page Giter Site logo

Comments (3)

szw avatar szw commented on May 18, 2024

Yeah, you're right. I'm going to update Vim help on weekend. I agree that reading html tables as a text file is cumbersome. They are purely intended to be rendered as in the README on Github. For a Vim help text version I need to prepare something else and therefore it's not the plain Copy-Paste-Reformat case ;).

BTW, I think some general introductory sections of README are unnecessary in the doc file (like "About", "Demo", or "Installation"). Any thoughts on that?

from vim-ctrlspace.

TaurusOlson avatar TaurusOlson commented on May 18, 2024

Yes, I also think that these sections should stay only in the README.

  • "About" may be a bit longer to be included in the help file
  • the link to the video in "Demo" should be kept because the video is great and explains very well what the plugin does
  • "Installation" is useless because if the user reads the help file that means that he/she has already installed the plugin

Tell me if you need some help to convert the html tables into something more human readable (reStructuredText, Markdown?)

from vim-ctrlspace.

szw avatar szw commented on May 18, 2024

Ok :).

As to tables, I think Markdown has nothing besides HTML to render tables. Perhaps I will try to handle tables in a reStructuredText fashion or just replace them with plain text.

from vim-ctrlspace.

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.