simple-remix-blog is a blog template built using remix.run and TailwindCSS. It supports markdown and MDX for the blog posts. You can clone it and start your own blog in a few minutes. Check out the documentation below to get started.

If you face any issues or have any suggestions, please open an issue!

Demo

simple-remix-blog.vercel.app

Screenshots

Quick start

Run the following command to create a project using this blog template:

npx create-remix@latest --template josemiguel-alvarez/simple-remix-blog

Once you've created the project you have to install the dependencies:

yarn install

and run the dev script:

yarn dev

Your blog should now be running on localhost:3000. There are some example posts in the template that you can remove when you're ready to start adding your own posts.

Then you have to update the app/siteMetadata.js file with your own information.

To create a new post you have to add a new markdown or MDX file in app/routes/posts. The project supports frontmatter, so you can add the post metadata formatted as YAML at the top of the file. Check the posts in this repository if you need an example.

Finally, include the new post in the POSTS constant in the app/utils/posts.server.ts file. The post should be available now in your blog.

Motivation

I built this blog template because I wanted to port my own personal site to Remix. I also wanted to contribute back to the community so I decided to build it as a Remix template.

Features

• Supports markdown and MDX
• Easily customizable using TailwindCSS
• Near perfect page performance
• Light and dark theme
• Responsive design
• Syntax highlighting for code blocks
• Support for tags
• SEO friendly
• About page
• Cache headers already pre-configured

Contributing

Feel free to open an issue if you have any suggestions or issues. I'll try to respond as soon as possible. You can also open a PR if you want to contribute to the project.

This project has the All Contributors bot installed, so please open a pull request to add yourself to the contributors list. Check the All Contributors documentation.

Contributing guide:

1. Fork & clone this project.
2. Run yarn install to install all the dependencies.
3. Run yarn dev to start the development server.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

José Miguel Álvarez Vañó 💻 📖

Amrendra Nath 💻

Elijah Trillionz 💻 🎨

This project follows the all-contributors specification. Contributions of any kind welcome!

License

simple-remix-blog is released under MIT License.