From 871ca835c579fa27aaaf09684040e81460a28a1b Mon Sep 17 00:00:00 2001 From: silviana amethyst <1388063+ofloveandhate@users.noreply.github.com> Date: Wed, 24 Jul 2024 12:09:19 -0500 Subject: [PATCH] factored out list of steps for publication of Documents --- docs/snippets/publication_process_document.rst | 12 ++++++++++++ docs/tutorials/markdown_python_extensions.rst | 13 +------------ 2 files changed, 13 insertions(+), 12 deletions(-) create mode 100644 docs/snippets/publication_process_document.rst diff --git a/docs/snippets/publication_process_document.rst b/docs/snippets/publication_process_document.rst new file mode 100644 index 0000000..62f3dbc --- /dev/null +++ b/docs/snippets/publication_process_document.rst @@ -0,0 +1,12 @@ +#. :doc:`The style is applied `. + + #. 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 `. +#. :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`. \ No newline at end of file diff --git a/docs/tutorials/markdown_python_extensions.rst b/docs/tutorials/markdown_python_extensions.rst index 4ee56cb..0159808 100644 --- a/docs/tutorials/markdown_python_extensions.rst +++ b/docs/tutorials/markdown_python_extensions.rst @@ -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 `. - - #. 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 `. -#. 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.