Make preparations for switching to markdown-generated HTML #41
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was referenced Feb 18, 2023
xogcox
force-pushed
the
align-to-markdown
branch
2 times, most recently
from
6bc96fa
to
d5c8b01
Compare
xogcox
force-pushed
the
align-to-markdown
branch
from
d5c8b01
to
a0c4a4a
Compare
xogcox
force-pushed
the
align-to-markdown
branch
from
a0c4a4a
to
5f2593f
Compare
added 22 commits
March 21, 2023 03:25
…h and add type attribute
added 5 commits
March 21, 2023 05:14
xogcox
force-pushed
the
align-to-markdown
branch
from
5f2593f
to
14e504c
Compare
|
I fully support the idea to switch to markdown-generated HTML, but right now it is not that easy to me to fully understand the status of this PR. What needs to be done to finally merge this work? I am willing to help, but a bit overwhelmed. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In pull request #35 for issue #8, I added a markdown version of the website, but the HTML files generated from the markdown couldn't be used directly, because they required some changes to the CSS and JavaScript files. (Also, the relative links to assets were broken, because the generated HTML was stored in a different directory from the original HTML.)
The current pull request resolves this by changing the original website HTML step by step in a series of commits, ending up with HTML that is identical to the markdown-generated files. These commits include the necessary changes to CSS styles, and in one case change to a few lines of the JavaScript used to highlight code blocks. There are also a few changes to the markdown itself and the shell script generating the HTML. I broke the PR down into a series of separate commits in order to show what changes are required.
The result is a working website that is almost identical to the one before the changes, with only subtle differences: the only ones I am aware of are curved quotation marks replacing straight quotation marks in the main text and the trimming of blank lines at the end of a couple of code blocks.
Of course, merging this pull request does not mean you have to switch to generating the website from the markdown source, but it removes almost all of the obstacles to adopting markdown, if you decide to. It shows what needs to change in order for the markdown source to be actually used for building the website. Please ask if you have any questions or want more details.