{"id":26009861,"url":"https://github.com/ajaust/mkdocs-poster-tutorial","last_synced_at":"2025-09-05T05:44:35.439Z","repository":{"id":117687876,"uuid":"282196984","full_name":"ajaust/mkdocs-poster-tutorial","owner":"ajaust","description":null,"archived":false,"fork":false,"pushed_at":"2020-07-30T06:31:03.000Z","size":2271,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-03-12T22:11:16.189Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","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/ajaust.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":"2020-07-24T11:00:57.000Z","updated_at":"2020-07-28T22:43:40.000Z","dependencies_parsed_at":null,"dependency_job_id":"7aebf516-59db-4f91-a184-6d03d0f25ccb","html_url":"https://github.com/ajaust/mkdocs-poster-tutorial","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ajaust/mkdocs-poster-tutorial","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ajaust%2Fmkdocs-poster-tutorial","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ajaust%2Fmkdocs-poster-tutorial/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ajaust%2Fmkdocs-poster-tutorial/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ajaust%2Fmkdocs-poster-tutorial/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ajaust","download_url":"https://codeload.github.com/ajaust/mkdocs-poster-tutorial/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ajaust%2Fmkdocs-poster-tutorial/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273718070,"owners_count":25155486,"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","status":"online","status_checked_at":"2025-09-05T02:00:09.113Z","response_time":402,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2025-03-05T22:05:02.329Z","updated_at":"2025-09-05T05:44:35.428Z","avatar_url":"https://github.com/ajaust.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# mkdocs-poster-tutorial\n\nThis README briefly explains what software needs to be installed and where to find further documentation\n\n## Installing dependencies\n\nThe **mandatory** requirements for the tutorial are `mkdocs` and the `mkdocs-material` theme. This includes some dependencies such as `Pygments` and `pymdown-extensions`.  This might be available via your package manager, but the packages might be old.\n\n1. Install pip for python3\n```\ncurl https://bootstrap.pypa.io/get-pip.py -o get-pip.py\npython3 get-pip.py --user\n```\n\n2. Install needed packages (List might be incomplete)\n```\npip3 install --user mkdocs mkdocs-material Pygments pymdown-extensions\n```\n\nThe **optional** dependencies are:\n\n- `ffmpeg`: Encoding/decoding videos\n- `asciinema`: Small videos of your terminal\n\n```bash\nsudo apt-get install ffmpeg asciinema\n```\n\n## Documentation\n\n- MkDocs: https://www.mkdocs.org/\n- Material theme: https://squidfunk.github.io/mkdocs-material/\n- Markdown (cheat sheet): https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet\n- ffmpeg: https://ffmpeg.org/documentation.html\n- asciinema: https://asciinema.org/docs/\n\n## Quickstart\n\nCreate page: `mkdocs serve`. You can check your homepage in a browser. The URL is usually http://127.0.0.1:8000/ Edit files: `mkdocs.yml` and `docs/index.md`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fajaust%2Fmkdocs-poster-tutorial","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fajaust%2Fmkdocs-poster-tutorial","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fajaust%2Fmkdocs-poster-tutorial/lists"}