-
Notifications
You must be signed in to change notification settings - Fork 0
Web Markup Cheatsheet
Your Internet browser interpret the Hyper Text Markup Language
, more known as its abbreviation HTML, using tags to format and display each Web page you see, as we use LaTeX
to format scientific and technical documents. It is however difficult to read through raw HTML code, hence other lighter Web markup languages have emerged, most notably the passe-partout Markdown
(of the GitHub Flavour: GFM) and reStructuredText
enabling documentation generation straight from comments in your Python
programs. The cheatsheet below selects commonalities between both to get your document more likely to process correctly on either type of software. Please use exactly this syntax to reduce, if not eliminate, time loss in converting your documents! When the syntax differs between Markdown
and reStructuredText
, we choose raw HTML tags, which should not significantly hinder readability and can usually be passed to the Web site generator.
Here be a table by Justine and/or Olivier for the most compatible cheatsheet between .rst .md with the corresponding HTML tags. See https://gist.github.com/dupuy/1855764 for a discussion of identities and differences Think about how to pass LaTeX as well to display equations, what's the name of the online software for that again, Mathjax? I think we should look into Pandoc (see links below) as well, as these developers have pondered document conversion for a long while and it might be insightful for our choice of syntax.
More Exhaustive Resources
- <a href="https://gist.github.com/dupuy/1855764">https://gist.github.com/dupuy/1855764</a> for a discussion of the correspondence between
.rst
and.md
- <a href="https://pandoc.org/MANUAL.html">https://pandoc.org/MANUAL.html</a> <a href="https://pandoc.org/index.html">Pandoc</a>, the swiss-army knife program to convert files from one markup format into another
> reStructuredText
- <a href="http://docutils.sourceforge.net/docs/user/rst/quickref.html">http://docutils.sourceforge.net/docs/user/rst/quickref.html</a> for a quick reference
> Markdown
- <a href="https://guides.github.com/features/mastering-markdown/">https://guides.github.com/features/mastering-markdown/</a> the Github guide on
Markdown
thus following GFM and its companion about proper <a href="https://guides.github.com/features/wikis/">project documentation</a> - <a href=""></a>main GFM documentation
- <a href="https://commonmark.org/help/">https://commonmark.org/help/</a>cheatsheet and tutorial for the <a href="https://spec.commonmark.org/0.29/">CommonMark specification</a> on which GFM is based
> HTML & Web Development
- <a href="https://developer.mozilla.org/en-US/docs/Learn">https://developer.mozilla.org/en-US/docs/Learn</a> tutorials by Mozilla developers: <a href="https://developer.mozilla.org/en-US/docs/MDN"> The MDN project</a>
- <a href="https://www.w3schools.com/">https://www.w3schools.com/</a> a convivial and popular site to learn Web development, though a bit heavy on advertising
- <a href="https://movethewebforward.org/">https://movethewebforward.org/</a> for more advanced Web development
*Note for Claudine: send this to the eventual Misc page or website generation on its own? > Documentation Generator - link to Sphinx - <a href="https://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html#todo-extension">https://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html#todo-extension</a> a reStructuredText & Sphinx cheatsheet
> Static Site Generators (SSG) ...Jekyll but LaTeX support is a concern:... - Typora - <a href="http://hackage.haskell.org/package/blatex">http://hackage.haskell.org/package/blatex</a>*
see nice examples from Simon Verret, Antoine Allard, Jean-Michel Ménard
> Web Content Management Systems (WCMS), the easiest way to go liki that wiki I guess, and the wiki way in general :) "MonPortail" @ ULaval en est probablement un aussi pour les pages de cours entre autres TYPO3 autrefois, but eurk. Drupal? Wix?
- Labo Safety & Admin
- Materials & Chemistry
- Optics of Condensed Matter (OMC)
- Optics
- Electronics, Data Acquisition & Processing
- Here will eventually be Charles' pages on balanced detection & processing pitfalls
- Maths & Computer Simulation
- Scientific Writing
- Modus Operandi
- Allen Edition Guide
- Word Processing
- Reference Management
- Research methodology @department: start from PHY-3003&2002/GPH-2006 docs+ work with the colleagues
-
$\Phi$
Grad Studies @ ULaval - Computing Wisdom