milan-codes.github.io

My personal portfolio and blog, built using Astro, and Tailwind. 👨‍💻

This is my personal portfolio and blog template. It allows you to create blog posts using Markdown, display math expressions using KaTeX, and includes analytics integration with Plausible, as well as a dark theme.

Features

• Markdown Support: You can create blog posts using Markdown syntax, making it easy to format your content.
• KaTeX Integration: The site supports displaying math expressions using KaTeX, enabling you to include mathematical formulas in your blog posts.
• Plausible Analytics: Analytics integration with Plausible allows you to track visitor statistics and gain insights into the site's performance.
• Light and Dark Theme: The site includes both light and dark themes, and the current theme is set based on system settings.

Development

This repository includes a Nix Flakes-based development environment. If Nix is configured on your system, run nix develop to enter the development environment. Optionally, direnv can automatically do this for you, when you change into the directory.

1. Install the necessary dependencies by running bun install.
2. Start the development server by running bun dev.

Deployment

This repository contains a workflow that automatically deploys to GitHub Pages, for other options refer to Astro's deployment guide.

Usage

Customizing Content

• Create new Markdown files in the src/pages/blog directory to add blog posts. You can use existing posts as a template. The url to the blog post will be the name of the Markdown file.

Displaying Math Expressions

• To display math expressions using KaTeX, wrap the LaTeX code within $$ symbols in your Markdown files. Example: $$E = mc^2$$
• Note that the displayed formulas might be too large for their containers. This might make the blog post's page unresponsive on certain devices. To avoid this, wrap the given formula in a <div class="overflow-x-scroll"> ... </div> container. You can see examples of this in the blog posts in this repository.

Analytics Integration with Plausible

1. Sign up for a Plausible Analytics account at Plausible.
2. After setting up your account, paste the given script in the src/layouts/BaseLayout.astro file, replacing the current one.

Dependencies

Refer to the package.json file for a complete list of dependencies and their versions.

Contributing

Contributions to this project are welcome! If you have any ideas, improvements, or bug fixes, please submit a pull request, or open a new issue.

License

You can reuse this template however you want, but do not reupload the blog posts to your deployed site.