Comments (4)
It makes sense to vender a stable version of nim-markdown
into the nim repo if koch is hard to do deps mgmt. BTW, nim-markdown is implemented in builtin modules like re and strutils, so it won't cause circular dependencies issue if goes with option 1.
My questions are:
- Do you have a timeline for the work?
- Who decides when the copied source should update?
- Is the code update by sending a pull request to devel branch?
from nim-markdown.
Do you have a timeline for the work?
it's pretty much a matter of doing the work (which I started as a proof of concept experiment in nim-lang/Nim#9487 ; looks promising, at least a number of RST files are converted perfectly (automatically)) ; after that, it's a matter of convincing whoever's not convinced yet that RST=>markdown transition is a good move before we can really do the transition;
it could happen quickly if the stars align but of course some convincing needs to happen.
it looks like there's a near consensus that markdown should be favored to RST, see: https://forum.nim-lang.org/t/4280 (Drop RST and join the Markdown train?)
I'd be in favor of doing it gradually, eg:
- first convert all doc/*.rst to md (dependency is less of an issue here since it's only for
./koch web
) - then figure out how to deal with RST doc comments (this could require the
copying over sources
option discussed above sonim doc
would be able to use markdown)
Who decides when the copied source should update?
whenever we want to benefit from a newly introduced feature in a more recent version of nim-markdown
I don't think this point is a big issue, so long we have proper tests in CI
Is the code update by sending a pull request to devel branch?
ya I don't see how else it'd work
- further question: this could become tricky if nim-markdown further down the line requires dependency on other packages (unless they'd be optional); is that going to be a potential problem or no dependencies are expected to happen in the future?
from nim-markdown.
Please go ahead. 👍
Re your further question. The answer is no. Nim-markdown aims to implement markdown based on nim standard libraries. In particular, re and strutils are the most used modules.
from nim-markdown.
Close the issue due to inactive status. Feel free to reopen the issue if needed.
from nim-markdown.
Related Issues (20)
- Warning: method has lock level <unknown>, but another method has 0 HOT 1
- Smartypants
- [Bug] Unable to parse gfm 0.29 spec.txt HOT 1
- Strikethrough in list doesn't work HOT 1
- htmlEntityToUtf8 adds around 600 kb to binary size with -d:release on Windows HOT 1
- How to produce AST? HOT 2
- Issue generating tables in newer versions HOT 2
- table rendering broken maybe? HOT 1
- Bad performance with larger documents HOT 4
- Error without stacktrace when parsing long, complex document inside a Html comment tag HOT 3
- Improve the Performance of nim-markdown HOT 1
- Document an example usage for parsing markdown into an AST HOT 8
- API docs missing? HOT 2
- Inline markdown with unmodified normal text
- Exported `toSeq` in this package robbed me of 3 hours of my life HOT 1
- Weird render when you have a trailing whitespace after triple backticks HOT 3
- Table are not processed correctly HOT 1
- Enhance post-processing
- Add footnote support
- Paragraph continuation broken in lists HOT 1
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 nim-markdown.