Scientific blog template based on AI Summer
The current template can be used for scientific blogs as it supports a wide variety of necessary components such as:
- Latex rendering
- Code blocks with highlighting
- References and citations
- Embed gifs and videos
- Interactive components
- Table of contents
- Similar articles
Other important features:
- Ability to filter and display posts by topic
- Customizable author pages
- 100% responsive
- Pages can be created with standard React code or using Markdown
- Search with a local index using flexsearch
- SEO ready
- Responsive images and image preprocessing pipeline
- Google analytics and tag manager
- robots.txt generation
- XML feed generation
- Sitemap generation
See a live example in our website
The template is based on theaisummer.com, which we strip from all the unecessary stuff in order to provide a minimal, ready-to-use but feature-rich framework for scientific blogs.
- The template is built with Gatsby v2 so some familiarity with React is required. For those who want to customize it, we highly recommend to check out the official Gatsby docs
- The Sass preprocessor is used for styling
- MDX is used instead of Markdown so we can add custom React components inside markdown. That enables us high customizeability, interactive widgets and more.
- Latex is rendered with Katex and remark-math
- Code blocks are rendered with prism-react-renderer
- Following Gatsby paradigm, GraphQL is used to query the website content
- Content can also be sourced using YAML files
- Forms can be created using react-hook-form
- Annimations on scroll support
How to run the template
- Instal the necessary dependencies
$ yarn install
- Run Gatsby
$ yarn start
What you need to do before deploying?
gatsby-configwith your site information
- Upload your logos and icons in
- Update the
- Update your themes in
- Update the yaml files in
How to deploy
- Build the final static files
$ yarn build
- Preview the website
$ yarn serve
- Transfer the
publicfolder to your hosting option of choice. For exammple, AI Summer is deployed on Firebase hosting, but any object storage will do just fine.
$ firebase deploy
If you really like this repository and find it useful, please consider (★) starring it, so that it can reach a broader audience of like-minded people. It would be highly appreciated 🙂 !
Contributing and Reporting Bugs
You are more than welcome to contribute to the template by adding more features, fixing bugs and more. Remember that this template was created by machine learning engineers and not web developers, so our sincere apologies in advance 😂
If you find a bug, create a GitHub issue, or even better, submit a pull request. Similarly, if you have questions, simply post them as GitHub issues. More info here.
Copyright 2022, AI Summer.
Licensed under the Apache License, Version 2.0
See the full license.