Giter VIP home page Giter VIP logo

chirpy-starter's Introduction

My Self-Hosted Documentation Site TEMPLATE

This repository contains the source code for my self-hosted documentation site, which is built using Jekyll with a base template from the Chirpy Jekyll theme.

Setup Instructions

  1. Update Site Details: Update the site details in the notes/_config.yml file to personalize it according to the preferences. This includes things like site title, description, author information, etc.

  2. Replace Favicons and Android Icons: Replace the default favicons and Android icons in the notes/assets/images/favicons directory to customize the appearance of the site.

  3. Store Markdown Files: Markdown files for the documentation should be stored in the notes/_posts directory. Ensure each markdown file follows the naming convention: YYYY-MM-DD-TITLE.md.

  4. Add Front Matter: At the top of each markdown file (*.md), include front matter to provide metadata about the markdown. Here's an example of what the front matter should look like:

---
title: TITLE
date: YYYY-MM-DD HH:MM:SS +/-TTTT
categories: [TOP_CATEGORIE, SUB_CATEGORIE]
tags: [TAG]     # TAG names should always be lowercase
---

Serving the Site

Once completed the necessary changes, Build and Deploy the docker container by running docker-compose up -d -build.

chirpy-starter's People

Contributors

gowdhamp avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.