Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dishwasher-detergent/corndocs

Documentation Made Easy
https://github.com/dishwasher-detergent/corndocs

documentation nextjs tailwind template

Last synced: about 2 months ago
JSON representation

Documentation Made Easy

Host: GitHub
URL: https://github.com/dishwasher-detergent/corndocs
Owner: dishwasher-detergent
License: mit
Created: 2022-09-21T14:25:38.000Z (over 2 years ago)
Default Branch: master
Last Pushed: 2024-05-22T18:31:00.000Z (7 months ago)
Last Synced: 2024-10-12T08:08:37.848Z (2 months ago)
Topics: documentation, nextjs, tailwind, template
Language: TypeScript
Homepage: https://www.corndocs.com
Size: 6.37 MB
Stars: 10
Watchers: 1
Forks: 5
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Getting Started

## Adding docs to your project

### Changing the environment variables

Go into the **corndocs.config.js** file and update the follow fields.

```js
/** @type {import('./types/ConfigType').Config} */

module.exports = {
darkMode: true,
search: {
algolia_admin_key: process.env.ALGOLIA_SEARCH_ADMIN_KEY,
algolia_app_id: process.env.NEXT_PUBLIC_ALGOLIA_APP_ID,
algolia_search_api_key: process.env.NEXT_PUBLIC_ALGOLIA_SEARCH_API_KEY,
algolia_index: "dev_corndocs",
},
project: {
name: "CornDocs",
url: "https://www.corndocs.com",
github: {
repo: "https://github.com/dishwasher-detergent/CornDocs",
usesMain: false,
},
logo: {
src: "/static/logo.svg",
alt: "CornDocs Logo",
size: [80, 40],
},
mainScreen: {
showSearch: true,
showSelection: true,
homePage: {
custom: {
path: "index",
},
title: "Build documentation that will impress your friends and family.",
tagLine:
"CornDocs lets you easily create documentation to show off your projects!",
},
},
},
};
```

### Setting sidebar order

For a file, you can set the sidebar order in the frontmattter. Use the key position.

```js
//_posts/doc.mdx
---
...
position: 1
...
---
```

For a folder, you can set the sidebar order in the define.json file. Use the key position.

```js
//_posts/Folder/define.json
{
...
"position": 1
...
}
```

### Changing the images

Go into the **public/static** folder and change the 2 images. Add your own logo and picture there. The logo must be in SVG format.

### Add your own content

Create a new file under the **\_posts** directory. Let's assume the new documentation file name is **getting-started.mdx**

You can nest files within folders.

#### Example:

```js
posts/
└── components/
├── Button
├── Link
└── Etc
```

Be careful about the name because it will be the url (path) for the documentation.

Every documentation has a top section where you can specify some meta data about that blog

```js
---
title: "Getting Started"
description: "This is a short description of the documentation"
banner: "/images/getting-started.jpeg"
tags: ["Setup"]
date: 1 October 2022
position: 1
---
```

### Adding an image for the documentation file and folder (Optional)

It is recommended the image is in the same file structure as the document that is referencing it.
So if the doc is in **Getting Started/Setup**, you should mirror this into the **public/images/** folder.

#### Documentation File Image

Add an image to the **public/images/** folder.

#### Folder Image

Add a define.json file within the folder. For the banner key add the path to the image you want for the folder.

#### Example:

```js
{
...
"banner": "/images/setup.jpg"
...
}
```

**or**

Add a image to the **public/images/(Folder Name)/(Folder Name.File Extension)**.

#### Example:

```js
public/
└── images/
├── sample.jpg
└── Getting Started/
├── getting-started.jpg (This will give the folder getting started an image)
└── setup.jpg (this will give the file setup.mdx an image if that was assigned in the frontmatter.)
```

## Setting up Favicon

Generate your favicon files through your favorite method, or use [https://www.favicon-generator.org/](https://www.favicon-generator.org/)

### Color customization

You can change the accent color to be whatever you like by going into **tailwind.config.js** and updating the primary color to your preference.

#### Example:

```js
const colors = require("tailwindcss/colors");

module.exports = {
...
theme: {
extend: {
colors: {
primary: colors.amber,
},
},
},
...
};
```

### Run the project to verify

If you want to test the project locally

```sh
npm run dev
```

and go to **http://localhost:3000/getting-started** to see the fruits of your labor!

## Deploy!

Once you're done, you can deploy to Vercel with the click of a button!

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fdishwasher-detergent%2FCornDocs&env=ALGOLIA_SEARCH_ADMIN_KEY,NEXT_PUBLIC_ALGOLIA_APP_ID,NEXT_PUBLIC_ALGOLIA_SEARCH_API_KEY&envDescription=Required%20API%20Keys&envLink=https%3A%2F%2Fcorndocs.com%2FDocs%2Fgetting-started&project-name=corndocs&repo-name=corndocs&demo-title=CornDocs&demo-description=Documentation%20Made%20Easy&demo-url=https%3A%2F%2Fcorndocs.com)

### Github Repo

[https://github.com/dishwasher-detergent/CornDocs](https://github.com/dishwasher-detergent/CornDocs)