Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
miljan-aleksic committed Sep 24, 2024
1 parent 32b0f13 commit 1f881bf
Showing 1 changed file with 5 additions and 23 deletions.
28 changes: 5 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Syntax
# ZOOlanders Documentation

Syntax is a [Tailwind UI](https://tailwindui.com) site template built using [Tailwind CSS](https://tailwindcss.com) and [Next.js](https://nextjs.org).
The documentation is based on [VitePress](https://vitepress.dev) with integration of [Algolia](https://www.algolia.com) search indexing.

## Getting started

To get started with this template, first install the npm dependencies:
First install the npm dependencies:

```bash
yarn install
Expand All @@ -13,25 +13,7 @@ yarn install
Next, run the development server:

```bash
yarn run dev
yarn dev
```

Finally, open [http://localhost:3000](http://localhost:3000) in your browser to view the website.

## Customizing

You can start editing this template by modifying the files in the `/src` folder. The site will auto-update as you edit these files.

## License

This site template is a commercial product and is licensed under the [Tailwind UI license](https://tailwindui.com/license).

## Learn more

To learn more about the technologies used in this site template, see the following resources:

- [Tailwind CSS](https://tailwindcss.com/docs) - the official Tailwind CSS documentation
- [Next.js](https://nextjs.org/docs) - the official Next.js documentation
- [Headless UI](https://headlessui.dev) - the official Headless UI documentation
- [Markdoc](https://markdoc.io) - the official Markdoc documentation
- [DocSearch](https://docsearch.algolia.com) - the official DocSearch documentation
Finally, open [http://localhost:5173](http://localhost:5173) in your browser to view the website. In case the port is occupied by another service, the next available port will be used and exposed in the console.

0 comments on commit 1f881bf

Please sign in to comment.