Skip to content

railspulse/rails_pulse_website

Repository files navigation

Documentation Template

Thank you for purchasing this template. I hope you build something great with it!

Features

  • Made with Astro, Markdown, Tailwind CSS and daisyUI
  • Search functionality
  • SEO friendly, Lightweight and fast
  • Dark mode and Light mode

Including

  • Homepage with features sections, code demo, contributors images, testimonials and installation guide
  • Document pages made from Markdown files with Sidebar, page content links, sponsors section
  • Search bar using Algolia DocSearch
  • Theme switch button with dark theme and light theme (compatible with all daisyUI themes)

Getting Started

  1. Install dependencies
npm install
  1. Run the dev server
npm run dev
  1. Build for production
npm run build

Setup Algolia DocSearch

  1. Create an account on Algolia DocSearch
  2. Add your website
  3. Create a .env file in the root directory
  4. Add your Algolia DocSearch API details to the .env file like this:
VITE_ALGOLIA_APP_ID=XXXXXXXXXX
VITE_ALGOLIA_API_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
VITE_ALGOLIA_INDEX_NAME=xxxxxxxx

Icons credit

Credit: Icons from Flat Icons

About

Rails Pulse documentation and marketing site

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors