docs

readme.md

@@ -19,7 +19,7 @@ The site is then deployed to [Vercel](http://vercel.com).
 ## Features
 
 - Setup only takes a few minutes! ([single config file](./site.config.js)) 💪
-- Next.js / TS / React / Notion -- what more could you want?!
+- Next.js / TS / React / Notion
 - Robust support for Notion content via [react-notion-x](https://github.com/NotionX/react-notion-x)
 - Excellent page speeds
 - Sexy LQIP image previews

site.config.js

@@ -1,47 +1,39 @@
 module.exports = {
-  // where it all starts -- the site's root Notion page
-  // required
+  // where it all starts -- the site's root Notion page (required)
   rootNotionPageId: '78fc5a4b88d74b0e824e29407e9f1ec1',
 
-  // basic site info
-  // required
+  // basic site info (required)
   name: 'Transitive Bullshit',
   domain: 'transitivebullsh.it',
   author: 'Travis Fischer',
 
-  // open graph metadata
-  // optional
+  // open graph metadata (optional)
   description: 'Personal site of Travis Fischer aka Transitive Bullshit',
   socialImageTitle: 'Transitive Bullshit',
   socialImageSubtitle: 'Hello World! 👋',
 
-  // social usernames
-  // optional
+  // social usernames (optional)
   twitter: 'transitive_bs',
   github: 'transitive-bullshit',
   linkedin: 'fisch2',
 
-  // default notion icon and cover images for site-wide consistency
+  // default notion icon and cover images for site-wide consistency (optional)
   // page-specific values will override these site-wide defaults
-  // optional
   defaultPageIcon:
     'https://ssfy.io/https%3A%2F%2Fwww.notion.so%2Fimage%2Fhttps%253A%252F%252Fs3-us-west-2.amazonaws.com%252Fsecure.notion-static.com%252F797768e4-f24a-4e65-bd4a-b622ae9671dc%252Fprofile-2020-280w-circle.png%3Ftable%3Dblock%26id%3D78fc5a4b-88d7-4b0e-824e-29407e9f1ec1%26cache%3Dv2',
   defaultPageCover:
     'https://ssfy.io/https%3A%2F%2Fwww.notion.so%2Fimage%2Fhttps%253A%252F%252Fs3-us-west-2.amazonaws.com%252Fsecure.notion-static.com%252F9fc5ecae-2b4b-4e73-b0d4-918c829ba69f%252FIMG_0259-opt.jpg%3Ftable%3Dblock%26id%3D78fc5a4b-88d7-4b0e-824e-29407e9f1ec1%26cache%3Dv2',
   defaultPageCoverPosition: 0.1862,
 
-  // image CDN host to proxy all image requests through
+  // image CDN host to proxy all image requests through (optional)
   // NOTE: this requires you to set up an external image proxy
-  // optional
   imageCDNHost: 'https://ssfy.io',
 
-  // Utteranc.es comments via GitHub issue comments
-  // optional
+  // Utteranc.es comments via GitHub issue comments (optional)
   utterancesGitHubRepo: 'transitive-bullshit/transitivebullsh.it',
 
-  // whether or not to enable support for LQIP preview images
+  // whether or not to enable support for LQIP preview images (optional)
   // NOTE: this requires you to set up Google Firebase and add the environment
   // variables specified in .env.example
-  // optional
   isPreviewImageSupportEnabled: true
 }