{"id":26179982,"url":"https://github.com/jellydn/mkdocs-legacy-deployment","last_synced_at":"2026-05-18T19:46:48.197Z","repository":{"id":181218455,"uuid":"666415971","full_name":"jellydn/mkdocs-legacy-deployment","owner":"jellydn","description":"This guide will show you how to convert markdown files to an HTML page and deploy old legacy documentation with MkDocs.","archived":false,"fork":false,"pushed_at":"2024-12-25T19:36:54.000Z","size":3131,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-11T21:53:59.392Z","etag":null,"topics":["documentation","markdown","mkdocs","typeorm"],"latest_commit_sha":null,"homepage":"https://typeorm-0238.vercel.app/","language":"HTML","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/jellydn.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},"funding":{"github":["jellydn"],"ko_fi":"dunghd","buy_me_a_coffee":"dunghd","polar":"jellydn"}},"created_at":"2023-07-14T13:11:40.000Z","updated_at":"2023-07-15T15:54:25.000Z","dependencies_parsed_at":"2024-12-25T20:33:14.304Z","dependency_job_id":null,"html_url":"https://github.com/jellydn/mkdocs-legacy-deployment","commit_stats":null,"previous_names":["jellydn/mkdocs-legacy-deployment"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/jellydn/mkdocs-legacy-deployment","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jellydn%2Fmkdocs-legacy-deployment","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jellydn%2Fmkdocs-legacy-deployment/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jellydn%2Fmkdocs-legacy-deployment/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jellydn%2Fmkdocs-legacy-deployment/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jellydn","download_url":"https://codeload.github.com/jellydn/mkdocs-legacy-deployment/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jellydn%2Fmkdocs-legacy-deployment/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266961874,"owners_count":24012985,"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-07-25T02:00:09.625Z","response_time":70,"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":["documentation","markdown","mkdocs","typeorm"],"created_at":"2025-03-11T21:54:02.234Z","updated_at":"2026-05-18T19:46:43.161Z","avatar_url":"https://github.com/jellydn.png","language":"HTML","funding_links":["https://github.com/sponsors/jellydn","https://ko-fi.com/dunghd","https://buymeacoffee.com/dunghd","https://polar.sh/jellydn","https://paypal.me/dunghd","https://www.buymeacoffee.com/dunghd"],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003eHow to Deploy Legacy Documentation with MkDocs 👋\u003c/h1\u003e\n\u003cp\u003eThis guide will show you how to convert markdown files to an HTML page and deploy old documentation with MkDocs.\u003c/p\u003e\n\n## Motivation\n\nAs the homepage has changed and only the latest version (e.g. TypeORM v0.3) is available on typeorm.com, it can be useful to deploy old documentation for reference.\n\n## Usage\n\n### ✨ [Demo](https://typeorm-0238.vercel.app/)\n\nTo deploy the markdown docs from the typeorm/typeorm repository on GitHub to Vercel, follow these steps:\n\n1. Clone the `typeorm/typeorm` repository using the `npx degit` command.\n\n```sh\nmkdir typeorm\ncd typeorm\nnpx degit typeorm/typeorm#0.2.38\n```\n\nThis will create a new directory called typeorm in your current directory. The directory will contain the source code for the TypeORM project, including the `docs` folder.\n\n2. Install `mkdocs`\n\n```sh\npip install mkdocs\n```\n\n3. Setup theme for document page\n\nCreate a `mkdocs.yml` with below configuration\n\n```yml\nsite_name: TypeORM v0.2.38\nsite_url: https://typeorm-legacy.productsway.com/\ntheme: readthedocs\n```\n\nThen run\n\n```sh\nmkdocs build\nnpx vercel site\n```\n\nThis will build a document site and deploy the markdown docs to Vercel, creating a live URL for you.\n\nHere is an example of the output of the `vercel deploy` command:\n\n```\nDeployment complete!\n\nYour project is now live at:\n\nhttps://your-project-name.vercel.app/\n```\n\nOnce the docs have been deployed, you can view them at the URL that was provided.\n\nSure, here is a reference section for the demo \"How to Deploy Old Legacy Documentation with MkDocs 👋\":\n\n### References\n\n- MkDocs Documentation: https://www.mkdocs.org/\n- How to Install Python: https://www.python.org/downloads/\n\n## Author\n\n👤 **Huynh Duc Dung**\n\n- Website: https://productsway.com/\n- Twitter: [@jellydn](https://twitter.com/jellydn)\n- Github: [@jellydn](https://github.com/jellydn)\n\n## Show your support\n\n[![kofi](https://img.shields.io/badge/Ko--fi-F16061?style=for-the-badge\u0026logo=ko-fi\u0026logoColor=white)](https://ko-fi.com/dunghd)\n[![paypal](https://img.shields.io/badge/PayPal-00457C?style=for-the-badge\u0026logo=paypal\u0026logoColor=white)](https://paypal.me/dunghd)\n[![buymeacoffee](https://img.shields.io/badge/Buy_Me_A_Coffee-FFDD00?style=for-the-badge\u0026logo=buy-me-a-coffee\u0026logoColor=black)](https://www.buymeacoffee.com/dunghd)\n\nGive a ⭐️ if this project helped you!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjellydn%2Fmkdocs-legacy-deployment","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjellydn%2Fmkdocs-legacy-deployment","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjellydn%2Fmkdocs-legacy-deployment/lists"}