Skip to content

Commit

Permalink
factored out list of steps for publication of Documents
Browse files Browse the repository at this point in the history
  • Loading branch information
ofloveandhate committed Jul 24, 2024
1 parent 351d622 commit 871ca83
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 12 deletions.
12 changes: 12 additions & 0 deletions docs/snippets/publication_process_document.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
#. :doc:`The style is applied <styling_content>`.

#. The markdown header and footer from the used style are assembled around your `source.md`.
#. The html header and footer from the used style are assembled around that.

#. :doc:`Replacements are done <text_replacements>`.
#. :doc:`Emoji shortcodes are emojified <../emoji>`
#. The markdown is translated to HTML.
#. :doc:`Links to existing content are implemented <../making_links_to_existing_content>`, further modifying the HTML.
#. Local files and images which are linked-to in the source are uploaded (if necessary), and the HTML is adjusted to use the Canvas links to that content.
#. Content properties are set from `meta.json`.
#. The content is placed in modules as described in `meta.json`.
13 changes: 1 addition & 12 deletions docs/tutorials/markdown_python_extensions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,7 @@ Background

Before I tell you how to use your own custom set of extensions to `markdown`, here's a brief rundown of how `markdown2canvas` works when you publish a page or assignment to Canvas:

#. :doc:`The style is applied <styling_content>`.

#. The markdown header and footer from the used style are assembled around your `source.md`.
#. The html header and footer from the used style are assembled around that.

#. :doc:`Replacements are done <text_replacements>`.
#. Emoji shortcodes are emojified
#. The markdown is translated to HTML. THIS IS THE STEP YOU CAN CUSTOMIZE.
#. :doc:`Links to existing content are implemented <../making_links_to_existing_content>`, further modifying the HTML.
#. Local files and images which are linked-to in the source are uploaded (if necessary), and the HTML is adjusted to use the Canvas links to that content.
#. Content properties are set from `meta.json`.
#. The content is placed in modules as described in `meta.json`.
.. include:: ../snippets/publication_process_document.rst

This tutorial is about customizing the first translation to HTML, by using `markdown` extensions.

Expand Down

0 comments on commit 871ca83

Please sign in to comment.