All Projects → tinacms → tina-starter-alpaca

tinacms / tina-starter-alpaca

Licence: other
NextJS Documentation starter powered by TinaCMS

Programming Languages

javascript
184084 projects - #8 most used programming language
CSS
56736 projects

Projects that are alternatives of or similar to tina-starter-alpaca

react-atdd-playground
Template to (deliberate) practice your test-driven development skills.
Stars: ✭ 14 (-74.55%)
Mutual labels:  nextjs-starter, vercel
nextjs-complete-boilerplate
Next js 12.3.1 boilerplate with Styled Components, Jest, React Testing Library, Prettier, ESLint, Plop JS and more 🚀
Stars: ✭ 50 (-9.09%)
Mutual labels:  nextjs-starter
dsmtech
🚀 The best tech companies and startups in the Greater Des Moines area.
Stars: ✭ 21 (-61.82%)
Mutual labels:  vercel
next-api-og-image
Easy way to generate open-graph images dynamically in HTML or React using Next.js API Routes. Suitable for serverless environment.
Stars: ✭ 179 (+225.45%)
Mutual labels:  vercel
phuctm97.com
🏚 Home on the Web
Stars: ✭ 41 (-25.45%)
Mutual labels:  vercel
rust
🦀 Rust runtime for ▲ Vercel Serverless Functions.
Stars: ✭ 339 (+516.36%)
Mutual labels:  vercel
unity-now
▲ Vercel Now plugin for Unity. Deploy WebGL builds with ease
Stars: ✭ 21 (-61.82%)
Mutual labels:  vercel
onedrive-vercel-index
OneDrive public directory listing, powered by Vercel and Next.js
Stars: ✭ 1,725 (+3036.36%)
Mutual labels:  vercel
youtube-json-server
Your personal Youtube API server to get Youtube API responses without needing credentials.
Stars: ✭ 32 (-41.82%)
Mutual labels:  vercel
github-jobs-client
Clone of GitHub Jobs website using the design from Frontend Mentor.
Stars: ✭ 22 (-60%)
Mutual labels:  vercel
coderplex-org
Official Website for Coderplex Community. Built with Next.js and deployed on Vercel.
Stars: ✭ 32 (-41.82%)
Mutual labels:  vercel
blog-nextjs-tina-tailwind
logana.dev
Stars: ✭ 19 (-65.45%)
Mutual labels:  vercel
code2img
Open REST API to create beautiful images of code snippets with 20+ color themes and syntax highlighting support for 10+ languages.
Stars: ✭ 25 (-54.55%)
Mutual labels:  vercel
StalkStock
A virtual trading website to practice trading stocks using virtual money.
Stars: ✭ 22 (-60%)
Mutual labels:  vercel
animeflix
A anime discovery, streaming site made with NextJs and TailwindCSS. Uses AniList API and video data from GogoAnime. No ads and no vpn required
Stars: ✭ 326 (+492.73%)
Mutual labels:  vercel
commercejs-chopchop-demo
A Commerce.js starter kit for Next.js. A beautifully designed elegantly developed, end to end commerce experience for developers and agencies. Pre-integrated with Stripe. One-click deploy to Vercel.
Stars: ✭ 129 (+134.55%)
Mutual labels:  vercel
nobelium
A static blog build on top of Notion and NextJS, deployed on Vercel.
Stars: ✭ 1,790 (+3154.55%)
Mutual labels:  vercel
screenREC
A really simple , ad-free & minimal web based screen recorder 📹
Stars: ✭ 67 (+21.82%)
Mutual labels:  vercel
nextjs-microcms-tsx-jamstack-aspida-boilerplate
This is a Next.js^9.5 project bootstrapped with microCMS, aspida. And this is using TSX, Incremental Static Regeneration.
Stars: ✭ 13 (-76.36%)
Mutual labels:  vercel
Portfolio
A Next.js & Material UI portfolio that stylizes markdown files from the GitHub API and Contentful CMS.
Stars: ✭ 18 (-67.27%)
Mutual labels:  vercel

Tina Starter Alpaca

A starting point for your documentation

Features

  • Full integration with Tina

  • Edit and add new documentation pages

  • Fully customizable Navigation

    • Organized your documentation into groups and subgroups
    • Change order of or the navigation
  • Theme Customization

    • Colors
    • Fonts
    • Titles

📝 Getting started on localhost

  1. Clone the repo git clone https://github.com/tinacms/tina-starter-alpaca.git
  2. cd tina-starter-alpaca
  3. Set up a GitHub OAuth App
  4. Add a new file called .env with the credentials from your Github OAuth App
# OAuth App Credentials from GitHub
GITHUB_CLIENT_ID=************
GITHUB_CLIENT_SECRET=************
SIGNING_KEY=*********

# The path to your repository in GitHub
REPO_FULL_NAME=<GitHub Username>/<Repo Name>

# The base branch that new changes and forks are created from. Defaults to 'master'.
BASE_BRANCH=master

You can learn more about Open Authoring With Github in our guide

  1. Install dependencies and run the doc starter:
yarn install
yarn dev

or

npm install
npm run dev
  1. Your doc starter should be up and running on http://localhost:3000!

  2. If you want the search functionality to work, follow these steps

    1. Make an account at algolia
    2. add environment variables to env file (found it the dashboard under the api keys tab)
     ALGOLIA_APP_ID=***
     ALGOLIA_API_KEY=***
     ALGOLIA_ADMIN_KEY=***
    
    1. run yarn create-indices (this command will have to be run every time you wish to update the indices)
    2. Complete the setup for each index (located on the right side panel)
      1. Configure searchable attributes (must add excerpt)
      2. Configure custom ranking (must add excerpt)
    3. Test and see the search is now working

Deploy on Vercel

Gathering Feedback with Github

People can submit feedback from any documentation page. This feedback is immediately posted to GitHub and stored as issues to the repository of your choosing. GitHub issues are an awesome way to store feeback, make it searchable, filterable on page URL or reaction types for instance, and you can choose to be notified of any new comment on your website 🔔.

Setup

  1. Make a personal GitHub access token 👈 This is the GitHub user that posts any new feedback. Feel free to create a dedicated GitHub account for this.
  2. Add the following environement variables:
USERNAME_ISSUES=<GitHub username>
GITHUB_ACCESS_TOKEN=<personal access token>
REPO_ISSUES=<repository-name> 

Make sure issues are activated in the repository settings.

  1. Run NextJS in development mode to test:
yarn
yarn dev
  1. Submit a feedback from the form at the bottom of a documenation page on your site.
  2. 👀 Check your GitHub repository if an issue has been created.

Gathering Feedback with another endpoint

If you want to use another service (like Formspree) you can change the endpoint that the form is send to. Simple add the following line to your .env file

FEEDBACK_ENDPOINT=https://example.com

🔗 Hosting

Deploy with Vercel

:octocat: Issues

If you notice any bugs or have any problems please report them here

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].