Tina Starter Alpaca

Overview

The Tina Starter Alpaca is a starting point for creating documentation websites. It provides full integration with TinaEdit and allows users to easily edit and add new documentation pages. The theme also offers a customizable navigation system, allowing users to organize their documentation into groups and subgroups, as well as change the order of the navigation. Additionally, the theme supports theme customization, including options for customizing colors, fonts, and titles.

Features

• Full integration with TinaEdit for easy editing and adding of documentation pages
• Fully customizable navigation system for organizing documentation
• Theme customization options for colors, fonts, and titles

Installation

To get started on localhost:

1. Clone the repository: git clone https://github.com/tinacms/tina-starter-alpaca.git
2. Change into the cloned directory: cd tina-starter-alpaca
3. Set up a GitHub OAuth App and add the credentials to a new file called .env
4. Install dependencies and run the doc starter
5. The doc starter will be running on http://localhost:3000

To enable search functionality:

1. Create an account at Algolia
2. Add environment variables to the .env file
3. Run yarn create-indices (this command needs to be run whenever you want to update the indices)
4. Complete the setup for each index (located on the right side panel)
5. Configure searchable attributes (must add excerpt)
6. Configure custom ranking (must add excerpt)
7. Test to see if the search is working

To deploy on Vercel:

1. Follow the steps to deploy NextJS on Vercel
2. Create a GitHub OAuth App with your Vercel URL

Summary

The Tina Starter Alpaca is a theme for creating documentation websites with easy integration with TinaEdit and a customizable navigation system. It provides a straightforward installation process and allows for theme customization. It also offers search functionality and the ability to gather feedback through GitHub integration. The theme can be deployed on Vercel for easy hosting.