{"id":17646577,"url":"https://github.com/dmetivie/pluto_export","last_synced_at":"2025-03-30T07:16:14.282Z","repository":{"id":244225655,"uuid":"814592420","full_name":"dmetivie/Pluto_export","owner":"dmetivie","description":"Static export of my pluto notebooks and where I store other materials","archived":false,"fork":false,"pushed_at":"2024-11-08T14:12:03.000Z","size":3073,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-05T09:21:18.234Z","etag":null,"topics":["jupyter-notebook","notebooks","pluto"],"latest_commit_sha":null,"homepage":"https://dmetivie.github.io/Pluto_export/","language":"Jupyter Notebook","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dmetivie.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-06-13T10:03:07.000Z","updated_at":"2024-11-08T14:11:00.000Z","dependencies_parsed_at":"2024-06-13T14:23:01.606Z","dependency_job_id":"486d037f-94c2-40f8-bada-be411e048777","html_url":"https://github.com/dmetivie/Pluto_export","commit_stats":null,"previous_names":["dmetivie/pluto_export"],"tags_count":0,"template":false,"template_full_name":"JuliaPluto/static-export-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dmetivie%2FPluto_export","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dmetivie%2FPluto_export/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dmetivie%2FPluto_export/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dmetivie%2FPluto_export/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dmetivie","download_url":"https://codeload.github.com/dmetivie/Pluto_export/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246285816,"owners_count":20752958,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["jupyter-notebook","notebooks","pluto"],"created_at":"2024-10-23T11:02:10.624Z","updated_at":"2025-03-30T07:16:14.261Z","avatar_url":"https://github.com/dmetivie.png","language":"Jupyter Notebook","readme":"# static-export-template\n\nThis is a demo repository containing two [Pluto](https://github.com/fonsp/Pluto.jl) notebooks that are **automatically converted to HTML** by a github action, and published to github pages! 🌝\n\nSee the github pages deployment of this repository:\nhttps://juliapluto.github.io/static-export-template/\n\n# How to use the template\n\n### 👉 Step 1\n\nCreate a GitHub account, and click on [\"Use this template\"](https://github.com/JuliaPluto/static-export-template/generate). Choose a new name!\n\n\u003cimg width=\"400\" alt=\"screenshot of clicking the Use-this-template button\" src=\"https://user-images.githubusercontent.com/6933510/103711531-f7cdc800-4fb7-11eb-98b7-6ebd070a337b.png\"\u003e\n\nYou now have your own repository (take a look at the URL), containing a copy of the template files, including the file you are currently reading (`README.md`)!\n\n### 👉 Step 2\n\nClick on **Add files** (or **+**), and then **Upload files**. In the next page, upload your `.jl` notebook files.\n\n\u003cimg width=\"400\" alt=\"screenshot of clicking the Upload-files button\" src=\"https://user-images.githubusercontent.com/6933510/103710071-67da4f00-4fb4-11eb-9943-b66f26119d36.png\"\u003e\n\nYour notebooks will run on github every time that you update the files in this repository. To check the progress, go to the [\"Actions\" page](./actions) of your repository, you will find the _workflow_ for the last commit.\n\n\u003cimg width=\"400\" alt=\"screenshot of the actions page, showing a currently running workflow\" src=\"https://user-images.githubusercontent.com/6933510/103711844-978b5600-4fb8-11eb-8b1b-1e5bdacc1c85.png\"\u003e\n\nWait for the Action to finish running your notebook.\n\n### 👉 Step 3\n\nGo to the [\"Settings\" page](./settings) of your repository, and go to [the \"Pages\" section](./settings/pages). For the \"Source\", choose `gh-pages`. Wait a minute for everything to initialize, and the URL to your web page will be shown! \n\n\u003cimg width=\"400\" alt=\"screenshot of the Pages settings, displaying the URL after the web page is ready\" src=\"https://user-images.githubusercontent.com/6933510/103711695-43807180-4fb8-11eb-9ba8-a96a70612177.png\"\u003e\n\nDon't worry if it doesn't work immediately! It can take a while for the web page to be ready, even after your settings page says it's done. (Github pages says 20 minutes, but it can take even longer.)\n\n## Update notebook files\n\nTo update an existing notebook file, simply repeat Step 2 above! (You can also use **Add files** `\u003e` **Upload files** to _update_ upload a file that already exists on the repository.)\n\n# Alternative setup: add web pages to an existing repository\n\nIf you already have a github repository with some pluto notebooks in it, you may want to add a web view like the one for this repository. In that case, the steps are slightly different. In this case, I assume that you are familiar with adding files to a repository. If not, follow the steps above.\n\n### 👉 Step 1\n\nFrom this repository, download [ExportPluto.yaml](./.github/workflows/ExportPluto.yaml). \n\nSave the file in your own repository, in the same location: make a folder `.github` in the main directory, within that a folder `workflows`, and add the file there, with the name `ExportPluto.yaml`. Commit the new file to your repository. \n\n*Note: The yaml file states that github should use the github notebooks in the `main` branch or `master` branch of your repository. If you changed the name of your default branch, or you want to use a different branch, change `main` in [line 5](https://github.com/JuliaPluto/static-export-template/blob/main/.github/workflows/ExportPluto.yaml#L5) in the yaml file to the name of your favourite branch.*\n\nYour notebooks will run on github every time that you update the files in this repository. To check the progress, click on [\"Actions\"](./actions), you will find the _workflow_ for the last commit.\n\n\u003cimg width=\"400\" alt=\"Schermafbeelding 2021-01-06 om 00 45 25\" src=\"https://user-images.githubusercontent.com/6933510/103711844-978b5600-4fb8-11eb-8b1b-1e5bdacc1c85.png\"\u003e\n\n### 👉 Step 2\n\nGo to the [\"Settings\" page](./settings) of your repository, and go to [the \"Pages\" section](./settings/pages). For the \"Source\", choose `gh-pages`. Wait a minute for everything to initialize, and the URL to your web page will be shown! \n\n\u003cimg width=\"400\" alt=\"Schermafbeelding 2021-01-06 om 00 43 00\" src=\"https://user-images.githubusercontent.com/6933510/103711695-43807180-4fb8-11eb-9ba8-a96a70612177.png\"\u003e\n\nDon't worry if it doesn't work immediately! It can take a while for the web page to be ready, even after your settings page says it's done. (Github pages says 20 minutes, but it can take even longer.)\n\n\n# 💡Tips\n\n### Julia Packages\n\nBecause Pluto has a [built-in package manager](https://github.com/fonsp/Pluto.jl/wiki/%F0%9F%8E%81-Package-management), packages will automatically work on the website!\n\n### Default files\n\nThis files `README.md` and `My cool notebook.jl` are example files, and you can safely edit or delete them! After you have set up your repository, you can remove these setup instructions from the `README.md` file, and write a description of your project.\n\n### Not working?\n\nIf your website is not automatically updating, then go to the **\"Actions\"** page of your repository, and take a look at the latest logs. If they show a ❌ symbol, then something went wrong. Click on it, and carefully read the error message. If you get stuck, be sure to ask for help: open an issue at https://github.com/JuliaPluto/static-export-template/issues/new and send us a link to your repository.\n\n### Homepage\n\nIf you go to the (GitHub Pages) URL of repository, you will see a small index of the notebooks in this repository. You can customize this page, two options are:\n\n-   Create your own `index.html` or `index.md` file, it will be used as the homepage.\n-   Rename one of your notebooks to `index.jl`, and it will be the default notebook!\n\n# License\n\nThis *template* repository is [Unlicensed](https://unlicense.org), which means that you can do anything you want with it! When you use this template, you are also free to remove this license message.\n\n\u003cdetails\u003e\n\u003csummary\u003eView license text\u003c/summary\u003e\n(This license applies to the template https://github.com/JuliaPluto/static-export-template, not necessarily to the user of the template.)\n\n```\nThis is free and unencumbered software released into the public domain.\n\nAnyone is free to copy, modify, publish, use, compile, sell, or\ndistribute this software, either in source code form or as a compiled\nbinary, for any purpose, commercial or non-commercial, and by any\nmeans.\n\nIn jurisdictions that recognize copyright laws, the author or authors\nof this software dedicate any and all copyright interest in the\nsoftware to the public domain. We make this dedication for the benefit\nof the public at large and to the detriment of our heirs and\nsuccessors. We intend this dedication to be an overt act of\nrelinquishment in perpetuity of all present and future rights to this\nsoftware under copyright law.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\nIN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR\nOTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,\nARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR\nOTHER DEALINGS IN THE SOFTWARE.\n\nFor more information, please refer to \u003chttps://unlicense.org\u003e\n```\n\u003c/details\u003e\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdmetivie%2Fpluto_export","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdmetivie%2Fpluto_export","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdmetivie%2Fpluto_export/lists"}