Comments (7)
@ajsebastian that is awesome! I think there are probably a few differences between the English and Chinese version at present just down to natural drifting within each section, which we will just have to accept for the time being. Thank you so much for figuring this out! I'm tied up this weekend but will review and merge in the coming week!
from howtobeaprogrammer.
Github-flavoured markdown doesn't support metadata, so it looks like I may need to add inline HTML into each file for the version number, either using <meta name="version" content="1.0.0" />
or something bespoke like <version number="1.0.0" />
. Has anyone come across this sort of thing before or know of a better approach for including version numbers?
from howtobeaprogrammer.
Hi! If you still need help doing this I would be more than willing to run through and insert this into the files.
from howtobeaprogrammer.
hey @ajsebastian, the issue that I've yet to resolve is how to add the version numbers so that they don't impact the readability of the pages on github or gitbook -- ideally, I want to be able to add the version numbers as metadata so that it doesn't render on the page
from howtobeaprogrammer.
@braydie That makes a lot more sense. After looking into it for a while it seems that the best way to add comments to markdown files which won't appear in the github page (it will still show in the raw data) is to format your comments like this: [//]: # (This may be the most platform independent comment) .
Everything inside of the parenthesis will not show unless you look at the raw data. I tested on a markdown file in a test directory here: https://github.com/ajsebastian/ajsebastian.github.io/blob/master/Comment%20showcase.md and it seems to work in the Github environment. You can see the comments by going to the raw or blame tabs. Let me know if this helped!
Edit: Also works with Gitbook as well.
from howtobeaprogrammer.
If you give me the version numbers and are satisfied with the comment method i could take this issue and update all of the files ASAP.
from howtobeaprogrammer.
I submitted a pull request of a version of the project where every file has a version number comment at the top. Hope this was helpful.
from howtobeaprogrammer.
Related Issues (20)
- For what is worth.. HOT 2
- Broken links HOT 5
- Copy from old Korean translation (GFDL) HOT 2
- Learn program HOT 1
- GitBook Export Links Broken HOT 1
- Darknet
- Epub Download? HOT 3
- Thank you
- F
- Learn
- Its not that hard
- Crypto
- How to be a programmer
- η¨εΊε‘
- Pop
- get repo as one file (PDF,epub) HOT 1
- Tool for exporting? HOT 2
- PDF HOT 4
- Language that welcomes both women and men? HOT 13
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 howtobeaprogrammer.