Kerala Developers website

Table of Contents

• create a blog post
• About
• Getting started
  • Project structure
  • Commands
  • Configuration
  • Deploy
• Frequently Asked Questions
• Contributing
• Acknowledgements
• License

Create Blogpost

fork the repository & create a pull request of a markdown/mdx file to src/content/post Copy the following markdown template as base

---
publishDate: 2023-01-09T00:00:00Z
title: post title
excerpt: A quick demo post
image: imagelink.jpeg
tags:
  - tag1
  - software
  - dev
---

## content

About

visit the website at https://keraladevelopers.github.io
join us on telegram at https://t.me/keraladevelopers

Getting started

Project structure

Inside website template, you'll see the following folders and files:

/
├── public/
│   ├── robots.txt
│   └── favicon.ico
├── src/
│   ├── assets/
│   │   ├── images/
│   │   └── styles/
│   │       └── base.css
│   ├── components/
│   │   ├── blog/
│   │   ├── common/
│   │   ├── widgets/
│   │   │   ├── Header.astro
│   │   │   └── ...
│   │   ├── CustomStyles.astro
│   │   └── Logo.astro
│   ├── content/
│   │   ├── post/
│   │   │   ├── post-slug-1.md
│   │   │   ├── post-slug-2.mdx
│   │   │   └── ...
│   │   └-- config.ts
│   ├── layouts/
│   │   ├── BaseLayout.astro
│   │   └── ...
│   ├── pages/
│   │   ├── [...blog]/
│   │   │   ├── [category]/
│   │   │   ├── [tag]/
│   │   │   ├── [...page].astro
│   │   │   └── index.astro
│   │   ├── index.astro
│   │   ├── 404.astro
│   │   ├-- rss.xml.ts
│   │   └── ...
│   ├── utils/
│   ├── config.mjs
│   └── data.js
├── package.json
├── astro.config.mjs
└── ...

Astro looks for .astro or .md files in the src/pages/ directory. Each page is exposed as a route based on its file name.

There's nothing special about src/components/, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.

Any static assets, like images, can be placed in the public/ directory if they do not require any transformation or in the assets/ directory if they are imported directly.

🧑‍🚀 Seasoned astronaut? Delete this file. Update config.mjs and contents. Have fun!

Commands

All commands are run from the root of the project, from a terminal:

Command	Action
npm install	Installs dependencies
npm run dev	Starts local dev server at localhost:3000
npm run build	Build your production site to ./dist/
npm run preview	Preview your build locally, before deploying
npm run format	Format codes with Prettier
npm run lint:eslint	Run Eslint
npm run astro ...	Run CLI commands like astro add, astro preview

Configuration

Basic configuration file: ./src/config.mjs

const CONFIG = {
  name: "Example",

  origin: "https://example.com",
  basePathname: "/", // Change this if you need to deploy to Github Pages, for example
  trailingSlash: false, // Generate permalinks with or without "/" at the end

  title: "Example - This is the homepage title of Example", // Default seo title
  description: "This is the homepage description of Example", // Default seo description
  defaultImage: "image.jpg", // Default seo image

  defaultTheme: "system", // Values: "system" | "light" | "dark" | "light:only" | "dark:only"

  language: "en", // Default language
  textDirection: "ltr", // Default html text direction

  dateFormatter: new Intl.DateTimeFormat("en", {
    // Date format
    year: "numeric",
    month: "short",
    day: "numeric",
    timeZone: "UTC",
  }),

  googleAnalyticsId: false, // Or "G-XXXXXXXXXX",
  googleSiteVerificationId: false, // Or some value,

  blog: {
    disabled: false,
    postsPerPage: 4,

    post: {
      permalink: "/%slug%", // variables: %slug%, %year%, %month%, %day%, %hour%, %minute%, %second%, %category%
      noindex: false,
      disabled: false,
    },

    list: {
      pathname: "blog", // Blog main path, you can change this to "articles" (/articles)
      noindex: false,
      disabled: false,
    },

    category: {
      pathname: "category", // Category main path /category/some-category
      noindex: true,
      disabled: false,
    },

    tag: {
      pathname: "tag", // Tag main path /tag/some-tag
      noindex: true,
      disabled: false,
    },
  },
};

Deploy

Deploy to production (manual)

You can create an optimized production build with:

npm run build

Now, your website is ready to be deployed. All generated files are located at dist folder, which you can deploy the folder to any hosting service you prefer.

Deploy to Netlify

Clone this repository on own GitHub account and deploy to Netlify:

Deploy to Vercel

Clone this repository on own GitHub account and deploy to Vercel:

Frequently Asked Questions

• faq?

Contributing

All the group members can request access to the repo and can contribute to resources or blogs if they'd like to

add markdown or mdx posts to src/content/post

Acknowledgements

Website based on astrowind initially created by onWidget

License

kd_website is licensed under the MIT license — see the LICENSE file for details.