Comments (4)
Here's a quick test of what the docs look like after running them through md2vim:
https://gist.github.com/michaelx386/24660963fed7d8330ab0
The README.markdown file might need adjusting to resolve some issues like some lines being too long:
1.7. Using wordy.......................................|vim-wordy-using_wordy|
1.7.1. Weak and lazy usage.................|vim-wordy-weak_and_lazy_usage|
1.7.2. Redundant and problematic usage.|vim-wordy-redundant_and_problematic_usage|
1.7.3. Puffery and Jargon...................|vim-wordy-puffery_and_jargon|
1.7.4. Manipulative language.............|vim-wordy-manipulative_language|
1.7.5. To be and the passive voice.|vim-wordy-to_be_and_the_passive_voice|
1.7.6. Colloquialisms, Idioms, and Similies.|vim-wordy-colloquialisms,_idioms,_and_similies|
1.7.7. Miscellaneous.............................|vim-wordy-miscellaneous|
from vim-wordy.
Forgot to mention md2vim allows the column length to be changed instead of the default 80 column width shown above so that's an option as well. I'm not sure what the guidelines are for Vim docs regarding column width, I guess 80 is the most compatible/standard size.
from vim-wordy.
Wow, that tool does a better job than I thought it might.
Feel free to modify the README for better results in the doc generation.
Agreed that 80 columns is a good target for the compatibility.
Thanks!
from vim-wordy.
I'll see if the file can be altered for a better fit. If not then perhaps md2vim can be set to only write the table of contents to a certain depth, say two levels in this case:
1. vim-wordy.................................................|vim-wordy-vim-wordy|
1.1. Features of the wordy plugin.....|vim-wordy-features_of_the_wordy_plugin|
1.2. What is wordy?.................................|vim-wordy-what_is_wordy?|
1.3. Why wordy?.........................................|vim-wordy-why_wordy?|
1.4. Requirements.....................................|vim-wordy-requirements|
1.5. Installation.....................................|vim-wordy-installation|
1.6. Configuration...................................|vim-wordy-configuration|
1.7. Using wordy.......................................|vim-wordy-using_wordy|
1.8. See also.............................................|vim-wordy-see_also|
1.9. Future development.........................|vim-wordy-future_development|
If that's suitable there might be a way to clean it up further by excluding the first level header which is only a title to flatten it out:
1. Features of the wordy plugin...........|vim-wordy-features_of_the_wordy_plugin|
2. What is wordy?.......................................|vim-wordy-what_is_wordy?|
3. Why wordy?...............................................|vim-wordy-why_wordy?|
4. Requirements...........................................|vim-wordy-requirements|
5. Installation...........................................|vim-wordy-installation|
6. Configuration.........................................|vim-wordy-configuration|
7. Using wordy.............................................|vim-wordy-using_wordy|
8. See also...................................................|vim-wordy-see_also|
9. Future development...............................|vim-wordy-future_development|
I'll take a closer look at md2vim to see what options are available.
from vim-wordy.
Related Issues (20)
- Feature request: highlight words that occur with an unusual frequency HOT 2
- Dictionary not being generated HOT 5
- Externalize the Word Lists as Structured Data HOT 8
- SpellRare HOT 6
- Highlight colour HOT 1
- Suggestion: highlight words overused in file HOT 8
- Support lists of adjectives and adverbs
- Alternatives in otherprograms HOT 1
- Alternatives in other programs HOT 5
- Conversion failure when creating word file HOT 4
- Support for TeX/LaTeX files
- How to add new rules of dictionary?
- Show suggestions HOT 1
- Conjugation checks
- Wordy doesn't work; invalid argument spelllang=en,/..... HOT 7
- Wordy calls spellcheck and Wordy check HOT 1
- Add a "cliches" dictionary
- Error: Can't open file for writing HOT 1
- Libraries are missing from ftp.nlugg.nl
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 vim-wordy.