{"id":16426362,"url":"https://github.com/dishwasher-detergent/corndocs","last_synced_at":"2025-03-21T04:30:33.269Z","repository":{"id":59836352,"uuid":"539529412","full_name":"dishwasher-detergent/CornDocs","owner":"dishwasher-detergent","description":"Documentation Made Easy","archived":false,"fork":false,"pushed_at":"2024-05-22T18:31:00.000Z","size":6676,"stargazers_count":10,"open_issues_count":0,"forks_count":5,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-10-12T08:08:37.848Z","etag":null,"topics":["documentation","nextjs","tailwind","template"],"latest_commit_sha":null,"homepage":"https://www.corndocs.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/dishwasher-detergent.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}},"created_at":"2022-09-21T14:25:38.000Z","updated_at":"2024-10-02T12:12:30.000Z","dependencies_parsed_at":"2024-03-02T15:26:19.176Z","dependency_job_id":"50107eef-52b2-4e17-9c75-58f1541c631a","html_url":"https://github.com/dishwasher-detergent/CornDocs","commit_stats":{"total_commits":225,"total_committers":3,"mean_commits":75.0,"dds":0.4488888888888889,"last_synced_commit":"87f3ea9bbb3ac5adec566dc27187a7db7198bd80"},"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dishwasher-detergent%2FCornDocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dishwasher-detergent%2FCornDocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dishwasher-detergent%2FCornDocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dishwasher-detergent%2FCornDocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dishwasher-detergent","download_url":"https://codeload.github.com/dishwasher-detergent/CornDocs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221811374,"owners_count":16884305,"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":["documentation","nextjs","tailwind","template"],"created_at":"2024-10-11T08:08:40.347Z","updated_at":"2024-10-28T09:18:54.676Z","avatar_url":"https://github.com/dishwasher-detergent.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Getting Started\n\n## Adding docs to your project\n\n### Changing the environment variables\n\nGo into the **corndocs.config.js** file and update the follow fields.\n\n```js\n/** @type {import('./types/ConfigType').Config} */\n\nmodule.exports = {\n  darkMode: true,\n  search: {\n    algolia_admin_key: process.env.ALGOLIA_SEARCH_ADMIN_KEY,\n    algolia_app_id: process.env.NEXT_PUBLIC_ALGOLIA_APP_ID,\n    algolia_search_api_key: process.env.NEXT_PUBLIC_ALGOLIA_SEARCH_API_KEY,\n    algolia_index: \"dev_corndocs\",\n  },\n  project: {\n    name: \"CornDocs\",\n    url: \"https://www.corndocs.com\",\n    github: {\n      repo: \"https://github.com/dishwasher-detergent/CornDocs\",\n      usesMain: false,\n    },\n    logo: {\n      src: \"/static/logo.svg\",\n      alt: \"CornDocs Logo\",\n      size: [80, 40],\n    },\n    mainScreen: {\n      showSearch: true,\n      showSelection: true,\n      homePage: {\n        custom: {\n          path: \"index\",\n        },\n        title: \"Build documentation that will impress your friends and family.\",\n        tagLine:\n          \"CornDocs lets you easily create documentation to show off your projects!\",\n      },\n    },\n  },\n};\n```\n\n### Setting sidebar order\n\nFor a file, you can set the sidebar order in the frontmattter. Use the key position.\n\n```js\n//_posts/doc.mdx\n---\n...\nposition: 1\n...\n---\n```\n\nFor a folder, you can set the sidebar order in the define.json file. Use the key position.\n\n```js\n//_posts/Folder/define.json\n{\n  ...\n  \"position\": 1\n  ...\n}\n```\n\n### Changing the images\n\nGo into the **public/static** folder and change the 2 images. Add your own logo and picture there. The logo must be in SVG format.\n\n### Add your own content\n\nCreate a new file under the **\\_posts** directory. Let's assume the new documentation file name is **getting-started.mdx**\n\nYou can nest files within folders.\n\n#### Example:\n\n```js\nposts/\n└── components/\n    ├── Button\n    ├── Link\n    └── Etc\n```\n\nBe careful about the name because it will be the url (path) for the documentation.\n\nEvery documentation has a top section where you can specify some meta data about that blog\n\n```js\n---\ntitle: \"Getting Started\"\ndescription: \"This is a short description of the documentation\"\nbanner: \"/images/getting-started.jpeg\"\ntags: [\"Setup\"]\ndate: 1 October 2022\nposition: 1\n---\n```\n\n### Adding an image for the documentation file and folder (Optional)\n\nIt is recommended the image is in the same file structure as the document that is referencing it.\nSo if the doc is in **Getting Started/Setup**, you should mirror this into the **public/images/** folder.\n\n#### Documentation File Image\n\nAdd an image to the **public/images/** folder.\n\n#### Folder Image\n\nAdd a define.json file within the folder. For the banner key add the path to the image you want for the folder.\n\n#### Example:\n\n```js\n{\n  ...\n  \"banner\": \"/images/setup.jpg\"\n  ...\n}\n```\n\n**or**\n\nAdd a image to the **public/images/(Folder Name)/(Folder Name.File Extension)**.\n\n#### Example:\n\n```js\npublic/\n└── images/\n    ├── sample.jpg\n    └── Getting Started/\n        ├── getting-started.jpg (This will give the folder getting started an image)\n        └── setup.jpg (this will give the file setup.mdx an image if that was assigned in the frontmatter.)\n```\n\n## Setting up Favicon\n\nGenerate your favicon files through your favorite method, or use [https://www.favicon-generator.org/](https://www.favicon-generator.org/)\n\n### Color customization\n\nYou can change the accent color to be whatever you like by going into **tailwind.config.js** and updating the primary color to your preference.\n\n#### Example:\n\n```js\nconst colors = require(\"tailwindcss/colors\");\n\nmodule.exports = {\n  ...\n  theme: {\n    extend: {\n      colors: {\n        primary: colors.amber,\n      },\n    },\n  },\n  ...\n};\n```\n\n### Run the project to verify\n\nIf you want to test the project locally\n\n```sh\nnpm run dev\n```\n\nand go to **http://localhost:3000/getting-started** to see the fruits of your labor!\n\n## Deploy!\n\nOnce you're done, you can deploy to Vercel with the click of a button!\n\n[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fdishwasher-detergent%2FCornDocs\u0026env=ALGOLIA_SEARCH_ADMIN_KEY,NEXT_PUBLIC_ALGOLIA_APP_ID,NEXT_PUBLIC_ALGOLIA_SEARCH_API_KEY\u0026envDescription=Required%20API%20Keys\u0026envLink=https%3A%2F%2Fcorndocs.com%2FDocs%2Fgetting-started\u0026project-name=corndocs\u0026repo-name=corndocs\u0026demo-title=CornDocs\u0026demo-description=Documentation%20Made%20Easy\u0026demo-url=https%3A%2F%2Fcorndocs.com)\n\n### Github Repo\n\n[https://github.com/dishwasher-detergent/CornDocs](https://github.com/dishwasher-detergent/CornDocs)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdishwasher-detergent%2Fcorndocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdishwasher-detergent%2Fcorndocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdishwasher-detergent%2Fcorndocs/lists"}