osmium-blog / osmium Goto Github PK

View Code? Open in Web Editor NEW

74.0 3.0 50.0 17.28 MB

A static site builder. Powered by Notion and Next.js

Home Page: https://osmium-blog.vercel.app

License: MIT License

JavaScript 12.94% TypeScript 65.00% SCSS 22.05%

blog documentation nextjs notion

osmium's Introduction

Osmium

A static blog site builder. Powered by Notion and Next.js

Osmium is a heavily-modded version of the awesome Nobelium

Highlights

🚀 It’s fast

Fully leverage SSR/SSG to pre-render pages as much as possible
Use Notion’s private API to ensure data-fetching efficiency

😌 It’s easy

Use only Notion and you got a fully functional blog
Manage your blog and posts in familiar Notion way

🤖 It’s smart

Auto-build-and-deploy your blog without any manual commands (if you are using Vercel or Netlify)
Once deployed, just write your blog and posts will automatically update thanks to ISR

Quick Start

In GitHub
- Fork this project
In Notion
- Duplicate this Notion Database, and share to web (optional but recommended)
- In the newly created database, find Config and open it
- Open the Osmium configurator, fill the form with your preferences and click the top-right button to copy your config
- Back to the page Config in Notion, remove the content of the code block and paste your config into it
- (Optional) Change the icon of the Config page. You can choose whichever type you like, no matter emoji or icon or image. That will be the logo and favicon of you blog
In Vercel (recommended) or other platform you choose to deploy to
- If you use Vercel, create a new project and link to your Osmium fork, then set the following environment variables:
  - NOTION_DATABASE_ID: The ID of the Notion Database you just created, usually a 32-digit or 36-digit hex code. You can find it from the page link in the share menu of the page. If you find two IDs, use the first one
  - NOTION_ACCESS_TOKEN (optional, not recommended): If you decide not to share your database, you can make Osmium grabbing data privately with the token. You can find it after the name token_v2 in your browser cookies
    - Notes: Notion token is only valid for 180 days. Don’t forget to update it in Vercel project settings before expiry. We’ll probably switch to the Notion Public API to resolve this issue in the future. Also, images may not be properly displayed in this case
- If you are not a Vercel user, just build and deploy your fork as a normal Next.js app with the environment variables described above
You are all set! Would you star this project? 🌟

Migrate from Nobelium

See https://osmium-blog.vercel.app/migrate-from-nobelium

FAQs

See https://osmium-blog.vercel.app/faqs

License

MIT

osmium's People

Contributors

Stargazers

Watchers

osmium's Issues

【问题反馈】Toogle下分列，若一列为db或view，则db显示失败。

osmium,nobelium皆无法显示。

示例页面：
osmium 1.1.2
nobelium
notionnetxt

Notion截图：

【问题反馈】横幅 + fullpage -> 破坏横向距离

多次测试，应该是跨屏横幅和full page这个功能共同作用的结果。
复现：

横屏图片
fullpage模式

浏览器：
https://blog.fpb.icu/test-Za2ltFRHb9qN21

notion：

【问题反馈】多view的database名称空白

https://blog.fpb.icu/musicgarden-680br87xfbhiND

【问题反馈】返回首页的url错误

图标上的返回地址正常，文字如下图所示

Issue with Vercel Deployment

DB is shared publicly
NOTION_DATABASE_ID
NOTION_ACCESS_TOKEN
Envs both set

Fetching config...
Calling `getPage` with ["34e19677-475e-4c80-af8f-5c8ae2dfc830"]
node:internal/process/promises:288
            triggerUncaughtException(err, true /* fromPromise */);
            ^
HTTPError: Response code 401 (Unauthorized)
    at Request.<anonymous> (/vercel/path0/node_modules/.pnpm/[email protected]/node_modules/got/dist/source/as-promise/index.js:118:42)
    at process.processTicksAndRejections (node:internal/process/task_queues:95:5) {
  code: 'ERR_NON_2XX_3XX_RESPONSE',
  timings: {
    start: 1711363761941,
    socket: 1711363761943,
    lookup: 1711363761944,
    connect: 1711363761947,
    secureConnect: 1711363761954,
    upload: 1711363761954,
    response: 1711363762075,
    end: 1711363762078,
    error: undefined,
    abort: undefined,
    phases: {
      wait: 2,
      dns: 1,
      tcp: 3,
      tls: 7,
      request: 0,
      firstByte: 121,
      download: 3,
      total: 137
    }
  }
}
Node.js v18.19.1
 ELIFECYCLE  Command failed with exit code 1.
Error: Command "pnpm run build" exited with 1

The burger button for docs outline panel should be hidden or disabled when there is no outline at all

[UI Improvement] Code block copy bottom

When I click the code block's copy bottom, the "copied" prompt will exceed the original scope of the code block.

If the code line's length exceed the passage's width, when I scroll the code, It looks a little wired.

Suggestion: delete this copy bottom

【问题反馈】搜索框下标签列表横向滑条缺失

【问题反馈】搜索结果间隔有问题

【问题反馈】非full page和full page图片展示逻辑不同

非full page下图片和Notion内显示一致，会横跨屏幕：
https://blog.fpb.icu/test-suHyZV223pc3Nr

fullpage下，反而不会横跨屏幕
https://blog.fpb.icu/test-suHyZV223pc3Nr14

全宽页面没有兼容，页面能不能不显示作者信息？

很喜欢这个博客，感觉比nobelium更友好更好用！
全宽页面下nobelium的导航栏和logo也是同步页面全宽的。
建议页面隐藏作者信息和发布时间，只有post下显示。

【Features Request】 Docs 支持Previous 和Next Post 切换

在Docs 的布局下，Post 的页脚，支持上一页与下一页的切换，顺序可以根据目录排序。

【问题反馈】utterances未加载

自动生成的配置文本。

  "comment": {
    "provider": "utterances",
    "utterancesConfig": {
      "repo": "fishpigbird/notiontalks"
    }
  }

【问题反馈】右下角黑色vercle缺失

Paragraph spacing is too small to be distinguished with line spacing

【功能讨论】画廊或正文点击page的反馈

osmium画廊展示
 notionnext画廊展示

在画廊中和正文中点击

在osmium中点击画廊或正文项目直接跳转至Notion。
在notionnext中点击画廊是查看图片
- 其实也以访问，如下图操作，因为它缓存了所有page内的page。但默认屏蔽（但为何还缓存呢？）
- 正文中也是默认屏蔽，但也访问对应缓存。
  
  https://notion.fpb.icu/86d16a8095b8476b854ee1dcd32c1cb9

讨论

画廊就可查看图片和点击属性即可。现在的跳转至Notion不是理想操作。
对于正文中的page项目，应该怎么办呢？直接跳转到notion？还是直接屏蔽？还是缓存？

Floating TOC Overlapping Code Blocks and Images

The floating TOC is causing an issue where it overlaps with the main content, specifically with code blocks and images.