https://github.com/haoranpb/vitepress-tailwind-documentation

Simplified Tailwindcss documentation site clone
https://github.com/haoranpb/vitepress-tailwind-documentation

clone documentation tailwindcss vitepress

Last synced: 11 months ago
JSON representation

Simplified Tailwindcss documentation site clone

• Host: GitHub
• URL: https://github.com/haoranpb/vitepress-tailwind-documentation
• Owner: haoranpb
• License: mit
• Created: 2021-05-05T11:45:03.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2022-02-03T22:14:09.000Z (over 4 years ago)
• Last Synced: 2023-03-10T18:26:28.399Z (over 3 years ago)
• Topics: clone, documentation, tailwindcss, vitepress
• Language: Vue
• Homepage: https://vitepress-tailwind-clone.netlify.app
• Size: 517 KB
• Stars: 6
• Watchers: 1
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Simplified Tailwindcss documentation site clone

Build with [VitePress](https://vitepress.vuejs.org) and [Tailwind CSS](https://tailwindcss.com)

## Why?

I love building elegant websites, especially when both design and css are taken care of :stuck_out_tongue_winking_eye:. Inspired by [vuejs/blog](https://github.com/vuejs/blog).

## What's missing?

As you can see on the [website](https://vitepress-tailwind-clone.netlify.app), many functionalities and styles are not implemented for simplicity.

## Development

### Add a new document

Put your document inside `docs` folder. Note: nested directories are not supported.

And then edit `.vitepress/config.js`

```js

module.exports = {

  ...

  themeConfig: {

    ...

    collections: {

      'New category': [

        'your document',

      ],

      ...

    },

  },

}

```

### Configuration

Take a look at [VitePress](https://vitepress.vuejs.org/guide/customization.html)'s documentation might help you further understand the structure.

## License

[MIT](https://github.com/haoranpb/vitepress-tailwind-documentation/blob/main/LICENSE)