{"id":16175259,"url":"https://github.com/app-generator/docusaurus-soft-design","last_synced_at":"2025-04-07T11:14:02.959Z","repository":{"id":82936109,"uuid":"603379836","full_name":"app-generator/docusaurus-soft-design","owner":"app-generator","description":"Docusaurus Soft Design - Open-Source | AppSeed","archived":false,"fork":false,"pushed_at":"2023-03-25T05:37:00.000Z","size":1893,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-06T18:13:25.850Z","etag":null,"topics":["appseed","documentation","docusaurus","soft-design"],"latest_commit_sha":null,"homepage":"https://docusaurus-soft-design.onrender.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/app-generator.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","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":"2023-02-18T10:33:19.000Z","updated_at":"2023-09-13T12:24:48.000Z","dependencies_parsed_at":null,"dependency_job_id":"45b1f294-5adf-4706-a04d-0f608b9a5b60","html_url":"https://github.com/app-generator/docusaurus-soft-design","commit_stats":null,"previous_names":[],"tags_count":9,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/app-generator%2Fdocusaurus-soft-design","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/app-generator%2Fdocusaurus-soft-design/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/app-generator%2Fdocusaurus-soft-design/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/app-generator%2Fdocusaurus-soft-design/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/app-generator","download_url":"https://codeload.github.com/app-generator/docusaurus-soft-design/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247640467,"owners_count":20971558,"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":["appseed","documentation","docusaurus","soft-design"],"created_at":"2024-10-10T04:44:29.301Z","updated_at":"2025-04-07T11:14:02.940Z","avatar_url":"https://github.com/app-generator.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# [Docusaurus Soft Design](https://github.com/app-generator/docusaurus-soft-design)\n\n**Open-Source Docusaurus Starter** styled with [Soft UI Design](https://bit.ly/soft-design-system), an open-source design from `Creative-Tim` - Actively supported by [AppSeed](https://appseed.us/).\n\n- 👉 [Docusaurus Soft Design](https://docusaurus-soft-design.onrender.com) - `LIVE Demo`\n- 👉 [Docusaurus Soft Design](https://www.youtube.com/watch?v=uRgQ_TpTj4g) - `video presentation`\n- 🚀 Free [support](https://appseed.us/support/) (email \u0026 `Discord`)\n\n\u003cbr /\u003e\n\n\u003e **Features**\n\n- ✅ **Docusaurus v2** \n- 🚀 `Blazing Fast` \n- ✅ Modern UI: **[Soft UI Design](https://bit.ly/soft-design-system)**, `Dark-Mode`\n- ✅ `MIT License`, Free **Support**  \n- ✅ **404 Events Reporting** via `Email.JS` \n- ✅ [Sticky Videos](https://docusaurus-soft-design.onrender.com/docs/tutorial-extras/sticky-media) for `YouTube`\n\n\u003cbr /\u003e\n\n![Docusaurus Soft UI Design - Open-source DOCS Starter.](https://user-images.githubusercontent.com/51070104/221350480-512c0088-84dd-49ac-a277-c09d0449054a.jpg)\n\n\u003cbr /\u003e\n\n### Installation\n\n-   yarn\n    ```sh\n    yarn\n    ```\n-   npm\n    ```sh\n    npm install\n    ```\n-   pnpm\n    ```sh\n    pnpm install\n    ```\n\n### Local Development\n\nThis command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.\n\n-   yarn\n    ```sh\n    yarn start\n    ```\n-   npm\n    ```sh\n    npm run start\n    ```\n-   pnpm\n    ```sh\n    pnpm run start\n    ```\n\n### Build\n\nThis command generates static content into the `build` directory and can be served using any static contents hosting service.\n\n-   yarn\n    ```sh\n    yarn build\n    ```\n-   npm\n    ```sh\n    npm run build\n    ```\n-   pnpm\n    ```sh\n    pnpm run build\n    ```\n\n### Deployment\n\nIf you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.\n\nUsing SSH:\n\n-   yarn\n    ```sh\n    USE_SSH=true yarn deploy\n    ```\n-   npm\n    ```sh\n    USE_SSH=true npm run deploy\n    ```\n-   pnpm\n    ```sh\n    USE_SSH=true pnpm run deploy\n    ```\n\nNot using SSH:\n\u003e Note: when prompted for password, enter personal access token.\n-   yarn\n    ```sh\n    GIT_USER=\u003cYour GitHub username\u003e yarn deploy\n    ```\n-   npm\n    ```sh\n    GIT_USER=\u003cYour GitHub username\u003e npm run deploy\n    ```\n-   pnpm\n    ```sh\n    GIT_USER=\u003cYour GitHub username\u003e pnpm run deploy\n    ```\n\n\u003cbr /\u003e\n\n### `404 Events` Reporting via [Email.JS](https://www.emailjs.com/)\n\nThis feature might be useful when we need to log the these events in order to add the missing pages or the corespondent `301` redirects. \n\n```bash\n$ cp env.sample .env\n$ vi .env\n```\n\nEdit email credentials: \n\n```env\nEMAILJS_SERVER_ID=REAL_VALUE_HERE\nEMAILJS_TEMPLATE_ID=REAL_VALUE_HERE\nEMAILJS_PUBLIC_KEY=REAL_VALUE_HERE\n```\n\n\u003cbr /\u003e\n\n## Links \u0026 Resources\n\n- 👉 Contact `AppSeed` using the [support](https://appseed.us/support/) page\n- 👉 [Migrate from GitBook to Docusaurus](https://docs.appseed.us/gitbook-to-docusaurus-migration/) - `step-by-step` guide\n\n--- \n[Docusaurus Soft Design](https://github.com/app-generator/docusaurus-soft-design) - `Free DOCS Starter` provided by **[AppSeed](https://appseed.us/)**.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapp-generator%2Fdocusaurus-soft-design","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapp-generator%2Fdocusaurus-soft-design","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapp-generator%2Fdocusaurus-soft-design/lists"}