avatar

Author: asmattic

README.md

@@ -1,37 +1,11 @@
 # Matthew Oldfield's Portfolio and Blog
 
-## Features
-
-- Easy styling customization with [Tailwind 3.0](https://tailwindcss.com/blog/tailwindcss-v3) and primary color attribute
-- Near perfect lighthouse score - [Lighthouse report](https://www.webpagetest.org/result/210111_DiC1_08f3670c3430bf4a9b76fc3b927716c5/)
-- Lightweight, 45kB first load JS, uses Preact in production build
-- Mobile-friendly view
-- Light and dark theme
-- Self-hosted font with [Fontsource](https://fontsource.org/)
-- Supports [plausible](https://plausible.io/), [simple analytics](https://simpleanalytics.com/) and google analytics
-- [MDX - write JSX in markdown documents!](https://mdxjs.com/)
-- Server-side syntax highlighting with line numbers and line highlighting via [rehype-prism-plus](https://github.com/timlrx/rehype-prism-plus)
-- Math display supported via [KaTeX](https://katex.org/)
-- Citation and bibliography support via [rehype-citation](https://github.com/timlrx/rehype-citation)
-- Automatic image optimization via [next/image](https://nextjs.org/docs/basic-features/image-optimization)
-- Flexible data retrieval with [mdx-bundler](https://github.com/kentcdodds/mdx-bundler)
-- Support for tags - each unique tag will be its own page
-- Support for multiple authors
-- Blog templates
-- TOC component
-- Support for nested routing of blog posts
-- Newsletter component with support for mailchimp, buttondown, convertkit and klaviyo
-- Supports [giscus](https://github.com/laymonage/giscus), [utterances](https://github.com/utterance/utterances) or disqus
-- Projects page
-- Preconfigured security headers
-- SEO friendly with RSS feed, sitemaps and more!
-
 ## Installation
 
 ```bash
 npm install
 ```
- 
+
 ## Development
 
 First, run the development server:
@@ -40,13 +14,15 @@ First, run the development server:
 npm run dev
 ```
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+Open [http://localhost:3000](http://localhost:3000)
 
 ## Extend / Customize
 
-`data/siteMetadata.js` - contains most of the site related information which should be modified for a user's need.
+`data/siteMetadata.js` - contains most of the site related information which should be modified for
+a user's need.
 
-`data/authors/default.md` - default author information (required). Additional authors can be added as files in `data/authors`.
+`data/authors/default.md` - default author information (required). Additional authors can be added
+as files in `data/authors`.
 
 `data/projectsData.js` - data used to generate styled card on the projects page.
 
@@ -58,19 +34,27 @@ Open [http://localhost:3000](http://localhost:3000) with your browser to see the
 
 `public/static` - store assets such as images and favicons.
 
-`tailwind.config.js` and `css/tailwind.css` - contain the tailwind stylesheet which can be modified to change the overall look and feel of the site.
+`tailwind.config.js` and `css/tailwind.css` - contain the tailwind stylesheet which can be modified
+to change the overall look and feel of the site.
 
-`css/prism.css` - controls the styles associated with the code blocks. Feel free to customize it and use your preferred prismjs theme e.g. [prism themes](https://github.com/PrismJS/prism-themes).
+`css/prism.css` - controls the styles associated with the code blocks. Feel free to customize it and
+use your preferred prismjs theme e.g. [prism themes](https://github.com/PrismJS/prism-themes).
 
-`components/social-icons` - to add other icons, simply copy an svg file from [Simple Icons](https://simpleicons.org/) and map them in `index.js`. Other icons use [heroicons](https://heroicons.com/).
+`components/social-icons` - to add other icons, simply copy an svg file from
+[Simple Icons](https://simpleicons.org/) and map them in `index.js`. Other icons use
+[heroicons](https://heroicons.com/).
 
-`components/MDXComponents.js` - pass your own JSX code or React component by specifying it over here. You can then call them directly in the `.mdx` or `.md` file. By default, a custom link and image component is passed.
+`components/MDXComponents.js` - pass your own JSX code or React component by specifying it over
+here. You can then call them directly in the `.mdx` or `.md` file. By default, a custom link and
+image component is passed.
 
 `layouts` - main templates used in pages.
 
-`pages` - pages to route to. Read the [Next.js documentation](https://nextjs.org/docs) for more information.
+`pages` - pages to route to. Read the [Next.js documentation](https://nextjs.org/docs) for more
+information.
 
-`next.config.js` - configuration related to Next.js. You need to adapt the Content Security Policy if you want to load scripts, images etc. from other domains.
+`next.config.js` - configuration related to Next.js. You need to adapt the Content Security Policy
+if you want to load scripts, images etc. from other domains.
 
 ## Post
 
@@ -119,10 +103,15 @@ Follow the interactive prompt to generate a post with pre-filled front matter.
 ## Deploy
 
 **Vercel**  
-Check out the [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
+Check out the [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more
+details.
 
-The API routes used in the newsletter component cannot be used in a static site export. You will need to use a form API endpoint provider and substitute the route in the newsletter component accordingly. Other hosting platforms such as Netlify also offer alternative solutions - please refer to their docs for more information.
+The API routes used in the newsletter component cannot be used in a static site export. You will
+need to use a form API endpoint provider and substitute the route in the newsletter component
+accordingly. Other hosting platforms such as Netlify also offer alternative solutions - please refer
+to their docs for more information.
 
 ## Licence
 
-[MIT](https://github.com/timlrx/tailwind-nextjs-starter-blog/blob/master/LICENSE) © [Timothy Lin](https://www.timrlx.com)
+[MIT](https://github.com/timlrx/tailwind-nextjs-starter-blog/blob/master/LICENSE) ©
+[Timothy Lin](https://www.timrlx.com)