Welcome to the source code a blog template based in Astro, TypeScript, and TailwindCSS. The content is dynamically generated from another repository through a GitHub Action by another template ansango/ansango.me.vault (you can use it!).
- Astro: A modern framework for building static websites.
- TypeScript: A strongly typed programming language that builds on JavaScript.
- TailwindCSS: A utility-first CSS framework for rapid UI development.
The project follows a typical Astro project structure with a few custom configurations to handle dynamic content:
- src/: Contains the main source code for the website, including pages, components, and styles.
- public/: Contains static assets like images and fonts.
- astro.config.mjs: Astro configuration file.
- tsconfig.json: TypeScript configuration file.
- tailwind.config.js: TailwindCSS configuration file.
The content for this website is not stored directly in this repository. Instead, it is generated from a separate repository (ansango/ansango.me.vault ) using a GitHub Action. This allows for dynamic content updates without modifying the core website structure. Clone the template too.
- Content Repository: The content is managed in the ansango/ansango.me.vault repository you can use tools like Obsidian to manage the content.
- GitHub Action: A GitHub Action in the content repository is triggered on push events.
- Deployment: The action builds the content and deploys it to this website, ensuring that the latest content is always displayed.
The website is automatically deployed using GitHub Actions and Cloudflare Pages. Whenever there are changes to the content or the source code, the following steps are performed:
- Build: The website is built using Astro.
- Deploy: The built site is deployed to Cloudflare Pages.
To set up the project locally for development:
-
Use the template repository and clone:
git clone https://github.com/YOUR_USER/YOUR_NEW_TEMPLATE cd YOUR_NEW_TEMPLATE
-
Install dependencies:
npm install
-
Run the development server:
npm start
This will start the Astro development server and you can view the website at
http://localhost:4321
.
Contributions are welcome! If you have any improvements or suggestions, please open an issue or submit a pull request.
- Fork the repository.
- Create a new branch (
git checkout -b feature/new-feature
). - Make your changes and commit them (
git commit -m 'Add new feature'
). - Push to the branch (
git push origin feature/new-feature
). - Open a Pull Request.
This project is licensed under the MIT License.