Comments (3)
Haha what a coincidence, I also finally got some time to work on standard-readme
again.
The roadmap in #1 seems a bit too IPFS specific, it hasn't been edited since the move, am I right?
Nevertheless: there was immediately feedback on my attempt to revive the project and @wooorm (the author of remark
) is still on board to help.
So we have the expert for the tool right away on the project.
I love to hear your findings since then, especially for the yet-not-decided topics! (like API section)
Maybe we can bundle the power again and eventually build a tool together, instead of parallel. :)
from standard-readme.
It has been edited a bit - I am going to make it a bit more general. But it will be a standard, and it won't be configurable - I am OK with that.
Yeah, @wooorm is awesome, but he's not going to do the work for us. :) The issue is that mdast doesn't have a .config option, at the moment, AFAIK. Instead of dealing with rules, I am just making very specific modules that deal with what I want and leaving it at that. It stops a ton of bikeshedding. If you want to help me make those, jump in. As it is, I'm expecting to ask @wooorm only for bug fixing, but I think we should be able to do this without too much effort.
I'm trying to build for IPFS because it seems easier to go with this specific use case than to build a generic tool. I do hope to add this to my generator-nms tool, too.
from standard-readme.
@zcei I edited it a lot, today! I've now got a full spec, and I'm working on a generator and a linter at the moment. Would love your feedback.
Going to close this, for now.
from standard-readme.
Related Issues (20)
- Improvement in License section HOT 1
- Question on Usage section HOT 1
- Question: clarifying on rules for install, usage, and contributing HOT 3
- Installation fails because of missing dependency to opencollective-postinstall HOT 1
- README.cn.md doesn't follow naming convention HOT 8
- Introduce REUSE compliance/compatibility HOT 1
- 您好,能写一个新手能看懂的教程吗?
- cat: spec.md: No such file or directory HOT 1
- README, Markdown and other formats HOT 1
- It's a good markdown file HOT 1
- Create a logo for Open Collective
- The "Install" section may not seem right for deployable websites HOT 2
- Does this project comply with standard-readme HOT 1
- Table of Contents Built in to GitHub HOT 2
- Demo
- Some links in the maximal example are broken HOT 4
- Add support for CHANGELOG.md? HOT 2
- Add a Credits/Thanks/Acknowledgements section HOT 6
- Examples use "contributing" which results in an error HOT 3
- Chinese translation HOT 3
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 standard-readme.