-
Notifications
You must be signed in to change notification settings - Fork 123
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Restructure user docs on MarkBind syntax #668
Conversation
Ready for review. As we did with the previous one, we can fix only major issues before merging. Minor issues can be fixed as followup PRs. It will take a few more iterations before the user docs are as polished as we want them to be. |
@Chng-Zhi-Xuan will need your help in reviewing this PR. |
For some reason, the Netlify preview appears broken 🤔 |
ac76878
to
1e3871a
Compare
Resolved merge conflict. |
Looks like netlify is getting some erros:
|
docs/userGuide/authoringContents.md
Outdated
|
||
{% set pages = [ | ||
['Adding Pagess', 'addingPages'], | ||
['MarkBind Syntax Overview', 'markbindSyntaxOverview'], |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
['Adding Pages', 'addingPages'],
['MarkBind Syntax Overview', 'markBindSyntaxOverview'],
399d668
to
baabc32
Compare
baabc32
to
4bed284
Compare
Let's merge this if there are no big problems -- if not, it will create merge conflict headaches for all the incoming PRs. No need to review content itself as I will be submitting more PRs to refine content further. We can do a fine-grain review of the text when the content is stable. |
On a side note for performance: Build time for documentation seems to have doubled since this PR was merged (was around ~3.174s before, now it is ~7.697s). |
Due to more source files, and more output files? 🤔 There are some nunjucks scripts too. |
What is the purpose of this pull request? (put "X" next to an item, remove the rest)
• [x] Documentation update
This is another update to user docs, focusing on how we describe MarkBind syntax. Overview:
userGuide/syntax/
folder.Authoring Contents
: added overviews of new pagesMarkBind Syntax Overview
: Previously this page contained all syntax (except components). Not it contains an overview only.Formatting Contents
: new page. Describes all syntax used for basic formatting.Using Components
: Revised to pull content from syntax/*.mbdf pagesUsing HTML, JavaScript, CSS
: new page.Tweaking the Page Structure
: Revised to pull content from syntax/*.mbdf pagesReusing Contents
: Revised to pull content from syntax/*.mbdf pagesMaking the Site Searchable
: Revised to pull content from syntax/*.mbdf pagesReader-Facing Features
: New page. Shows features that will be visible to readers.Full Syntax Reference
: Alphabetical list of all syntaxSyntax Cheat Sheet
: new page