📘
GitBook
  • 📘GitBook
Powered by GitBook
On this page
  • About
  • Features
  • Opportunities
  • Editor
  • Publish
  • Version control systems (VCS)
  • Hosting
  • Research
  • Security
  • UX

GitBook

Last updated 2 years ago

About

Site:

Docs:

Sample:

Support:

Features

Editor

  • What you see is what you get () editor for Markdown

  • Light/dark mode

    • Toggle: cmd + k > Type Switch to [dark/light] mode.

Collaboration

Version control systems (VCS)

  • GitBook platform versioning

    • Two-way syncing updates

      • GitBook to GitLab/GitHub repository

      • GitLab/GitHub repository to GitBook

Publish

  • Custom readable links by default

    • [space-name].gitbook.io/[page-name]

  • Custom domains

  • Layouts

    • Right menu (Overflow button "⬇️" if hidden in the top-right of the menu) > Page Layout

      • Docs page: "A standard page, with table of contents and an outline."

      • Editorial post: "No table of contents, but visible page outline. Great for blogs!"

      • Landing page: "A full-width page, with no table of contents and no outline."

  • Static light/dark mode

    • Menu bar (Top when in non-edit mode) > Customize > Theme mode

Security

  • Data is encrypted in transit and once in storage on Google Cloud.

Opportunities

Editor

Buggy (P0)

  • Cursor can lag.

  • Sometimes errors copy and pasting.

Slight delay to publish (P1)

  • Slightly slower to publish than Notion and HackMD which show updates to the current version in view mode instantly.

Publish

Copy and paste text (P0)

  • Issues highlighting, copying, and pasting the published text including lists and links

  • Cannot copy and paste lists.

  • Copying and pasting text with links technically works, but appears to the user that it is not highlighting the full text.

  • This makes it hard for the reader to interact with the content.

  • Browsers

    • Chrome: Not as bad. Missing some body content

    • Firefox: Missing lists and links.

Second-level unordered lists not formatting correctly (P0)

  • This first-level bullet is formatted correctly.

    • This second-level bullet is not formatted correctly.

  • This can be confusing to the reader and appear to be a typo.

H4 headers are not available (P0)

  • Useful as a replacement for bold text to use a header link in order to deep-link into.

Table of contents (ToC) viewable in different screen sizes (P1)

  • The ToC is only displayed when the window takes up the full screen.

  • This make it hard for the reader to navigate longer or complex content.

  • Not as dynamic as HackMD’s navigation button for narrow screen views.

Global navigation menu is not dynamic when the table of contents (ToC) are showing (P1)

  • It's useful to have both a ToC and navigation menu.

    • ToC helps quickly navigate within the current page.

    • Navigation menu helps move between related topics.

  • The menu should be dynamic based on the screen size and be manually collapsible (Similar to HackMD's UX).

Mobile app for reading and editing (P1)

Publish view light/dark mode (P2)

  • Based on system settings

  • Manual toggle for the user

Version control systems (VCS)

Radical integration (P2)

Hosting

Deploy to Arweave and IPFS (P2)

Research

Security

UX

This is not technical advice. Always read the official documentation and do your own research.

e.g.

See

See

Site:

Workaround: Use a secure email as login without setting a password. e.g. or

📘
gitbook.com
docs.gitbook.com
manual.makerdao.com
support@gitbook.com
WYSIWYG
Personal account settings > How to access your personal account settings > Account settings > Preferences
Member management
Version control
Git Sync
open-guides.gitbook.io/gitbook
Set a custom domain
Space Customization > General > Theme mode
Security FAQ > Is customer data encrypted?
Sample video 2023-02-14
Sample video 2023-02-14
Sample video 2023-02-14
radicle.xyz
Skiff
Proton Mail
Page Layout