diff --git a/.nojekyll b/.nojekyll index 85db7cb..c166a86 100644 --- a/.nojekyll +++ b/.nojekyll @@ -1 +1 @@ -d13d5e0a \ No newline at end of file +27e76c62 \ No newline at end of file diff --git a/search.json b/search.json index 228dadc..b233f50 100644 --- a/search.json +++ b/search.json @@ -104,6 +104,61 @@ "Tutorials" ] }, + { + "objectID": "tutorials/tutorial-02.html", + "href": "tutorials/tutorial-02.html", + "title": "Adding content", + "section": "", + "text": "After the first tutorial, we have a basic Quarto website running. But what if we want to add more things?\n\n\nAt the start of every .qmd file you create, add the lines\n\n---\nengine: julia\n---\n\n\nso Quarto will use the julia engine (and not the jupyter one).\n\n\n\nAll .qmd files in the docs/tutorials folder will be rendered and put together on the Tutorials tab. If you want more control over which .qmd files will be rendered and in which order, you will need to edit the file docs/_quarto.yaml. See more details at the Quarto official documentation.\nIn TidierIteration.jl, I added the following files\n\nwhich rendered as follows\n\n\n\n\nIf you kept developing your package and added more functions (or modified some existent ones), it is a good idea to remake all .qmd files on the docs/reference/ folder. To do that, activate the docs/ environment like in the previous tutorial and run the following:\n\nusing .TidierIteration\nusing QuartoDocBuilder\n\nobjs = get_objects_from_module(module_name)\nobjs .|> quarto_doc_page\n\nThis can also be written in the docs/make.jl file. If you want to rewrite the docs/reference.qmd file, add the following line:\n\nquarto_build_refpage(TidierIteration)\n\nBe careful: this will overwrite your current docs/reference.qmd file! In case you want to write the content of this file into another file, pass the optional argument output:\n\nquarto_build_refpage(TidierIteration, output = \"docs/reference2.qmd\")\n\n\n\n\nAll this can be done by modifying the docs/_quarto.yaml file. Learn how to do it here. For example, here are different ways to navigate in your site, changing the header and so on.", + "crumbs": [ + "Tutorials", + "Adding content" + ] + }, + { + "objectID": "tutorials/tutorial-02.html#the-julia-engine", + "href": "tutorials/tutorial-02.html#the-julia-engine", + "title": "Adding content", + "section": "", + "text": "At the start of every .qmd file you create, add the lines\n\n---\nengine: julia\n---\n\n\nso Quarto will use the julia engine (and not the jupyter one).", + "crumbs": [ + "Tutorials", + "Adding content" + ] + }, + { + "objectID": "tutorials/tutorial-02.html#adding-tutorials", + "href": "tutorials/tutorial-02.html#adding-tutorials", + "title": "Adding content", + "section": "", + "text": "All .qmd files in the docs/tutorials folder will be rendered and put together on the Tutorials tab. If you want more control over which .qmd files will be rendered and in which order, you will need to edit the file docs/_quarto.yaml. See more details at the Quarto official documentation.\nIn TidierIteration.jl, I added the following files\n\nwhich rendered as follows", + "crumbs": [ + "Tutorials", + "Adding content" + ] + }, + { + "objectID": "tutorials/tutorial-02.html#adding-more-function-to-the-reference-page", + "href": "tutorials/tutorial-02.html#adding-more-function-to-the-reference-page", + "title": "Adding content", + "section": "", + "text": "If you kept developing your package and added more functions (or modified some existent ones), it is a good idea to remake all .qmd files on the docs/reference/ folder. To do that, activate the docs/ environment like in the previous tutorial and run the following:\n\nusing .TidierIteration\nusing QuartoDocBuilder\n\nobjs = get_objects_from_module(module_name)\nobjs .|> quarto_doc_page\n\nThis can also be written in the docs/make.jl file. If you want to rewrite the docs/reference.qmd file, add the following line:\n\nquarto_build_refpage(TidierIteration)\n\nBe careful: this will overwrite your current docs/reference.qmd file! In case you want to write the content of this file into another file, pass the optional argument output:\n\nquarto_build_refpage(TidierIteration, output = \"docs/reference2.qmd\")", + "crumbs": [ + "Tutorials", + "Adding content" + ] + }, + { + "objectID": "tutorials/tutorial-02.html#creating-more-tabs-adjusting-the-layout-and-so-on", + "href": "tutorials/tutorial-02.html#creating-more-tabs-adjusting-the-layout-and-so-on", + "title": "Adding content", + "section": "", + "text": "All this can be done by modifying the docs/_quarto.yaml file. Learn how to do it here. For example, here are different ways to navigate in your site, changing the header and so on.", + "crumbs": [ + "Tutorials", + "Adding content" + ] + }, { "objectID": "reference.html", "href": "reference.html", diff --git a/tutorials.html b/tutorials.html index 2e34c6d..414c23b 100644 --- a/tutorials.html +++ b/tutorials.html @@ -130,6 +130,12 @@ From zero to nice docs! + +
  • +
    + + Adding content +
    • diff --git a/tutorials/tutorial-01.html b/tutorials/tutorial-01.html index c5a9596..b4bbcde 100644 --- a/tutorials/tutorial-01.html +++ b/tutorials/tutorial-01.html @@ -64,6 +64,7 @@ + @@ -164,6 +165,12 @@ From zero to nice docs! + +
  • +
    + + Adding content +
    • @@ -733,6 +740,9 @@

    Next steps

    + + Adding content +
    diff --git a/tutorials/tutorial-02-files.png b/tutorials/tutorial-02-files.png new file mode 100644 index 0000000..e2a9bda Binary files /dev/null and b/tutorials/tutorial-02-files.png differ diff --git a/tutorials/tutorial-02-rendered.png b/tutorials/tutorial-02-rendered.png new file mode 100644 index 0000000..d53fa73 Binary files /dev/null and b/tutorials/tutorial-02-rendered.png differ diff --git a/tutorials/tutorial-02.html b/tutorials/tutorial-02.html new file mode 100644 index 0000000..d55ea3a --- /dev/null +++ b/tutorials/tutorial-02.html @@ -0,0 +1,688 @@ + + + + + + + + + +tutorial-02 + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + +
    + +
    + + +
    + + + +
    + + + + +
    +

    Adding content

    +

    After the first tutorial, we have a basic Quarto website running. But what if we want to add more things?

    +
    +

    The julia engine

    +

    At the start of every .qmd file you create, add the lines

    +
    
+---
+engine: julia
+---
+
+
    +

    so Quarto will use the julia engine (and not the jupyter one).

    +
    +
    +

    Adding tutorials

    +

    All .qmd files in the docs/tutorials folder will be rendered and put together on the Tutorials tab. If you want more control over which .qmd files will be rendered and in which order, you will need to edit the file docs/_quarto.yaml. See more details at the Quarto official documentation.

    +

    In TidierIteration.jl, I added the following files

    +

    +

    which rendered as follows

    +

    +
    +
    +

    Adding more function to the Reference page

    +

    If you kept developing your package and added more functions (or modified some existent ones), it is a good idea to remake all .qmd files on the docs/reference/ folder. To do that, activate the docs/ environment like in the previous tutorial and run the following:

    +
    +
    using .TidierIteration
+using QuartoDocBuilder
+
+objs = get_objects_from_module(module_name)
+objs .|> quarto_doc_page
    +
    +

    This can also be written in the docs/make.jl file. If you want to rewrite the docs/reference.qmd file, add the following line:

    +
    +
    quarto_build_refpage(TidierIteration)
    +
    +

    Be careful: this will overwrite your current docs/reference.qmd file! In case you want to write the content of this file into another file, pass the optional argument output:

    +
    +
    quarto_build_refpage(TidierIteration, output = "docs/reference2.qmd")
    +
    +
    +
    +

    Creating more tabs, adjusting the layout and so on

    +

    All this can be done by modifying the docs/_quarto.yaml file. Learn how to do it here. For example, here are different ways to navigate in your site, changing the header and so on.

    + + +
    +
    + +
    + + + + + +
    + + + + + \ No newline at end of file