02-1. How to write articles

icon-administrator administrator
Published: Feb. 4, 2026, 3:24 p.m. UTC / Updated: Feb. 4, 2026, 3:27 p.m. UTC
👍 0
🔖 0 Bookmarks
English

This guide explains how to create and manage articles in PinotWalk.

Markdown Syntax {#markdown-basics}

  • PinotWalk articles are written in Markdown format.
  • Markdown allows you to create readable documents with simple syntax.
  • For a detailed Markdown tutorial, click here.
  • But if learning it yourself seems difficult... don't worry, your Secretary will handle everything for you!

Mermaid Diagrams {#mermaid-diagrams}

  • Mermaid syntax allows you to auto-generate diagrams from text.
graph TD
    A[Start] --> B[Process]
    B --> C[End]
  • You can create various diagrams including flowcharts, sequence diagrams, Gantt charts, and more.
  • For detailed Mermaid syntax, please refer to the following tutorials:
  • Mermaid Syntax Tutorial
  • Mermaid Official Documentation
  • But if learning it yourself seems difficult... don't worry, your Secretary will handle everything for you! You just need to say "draw this diagram in mermaid."

Managing Spaces & Articles {#spaces-and-articles}

Concept Overview

PinotWalk content is organized in the following hierarchy:

Organization (e.g., company - the billing unit)
  └── Team (e.g., department - people with the same business function)
        └── Space (specific work/project unit)
              └── Article
Concept Description Example
Organization Company or entity Acme Inc.
Team Group within organization Dev Team, Marketing Team
Space Folder for organizing articles Project A, Meeting Notes
Article Individual document Design Doc, Report

Space Operations

Creating a Space

  1. Click on the person icon hamburger menu in the upper right and select My Page
  2. Select "Space"
  3. Enter the Space name
  4. Select the team it belongs to
  5. Click "Create"

Space Settings

Setting Description
Space Name Display name
Description Space overview
Visibility Public / Team only / Private
Icon Icon displayed in Space list

Organizing Spaces

  • Sub-Space: You can create Spaces within a Space
  • Move: You can move articles to another Space
  • Archive: You can archive Spaces you no longer use

Article Operations

Creating an Article

  1. Click "New" within a Space
  2. Or, from the sidebar "New" → "Article"
  3. Enter the title
  4. Write the content in Markdown
  5. Click "Save"

Editing an Article

  1. Open the article
  2. Click the "Edit" button
  3. Edit the content
  4. Click "Save"

Auto-Save

Your work is automatically saved at regular intervals while editing.
Even if you close the browser, your draft will not be lost.

Version History

You can view the change history of an article.

  1. Open the article
  2. "︙" menu → "History"
  3. View and restore previous versions

Full-Text Search

You can search article content from the search box in the header.

  • Title
  • Body
  • Author

Filters

You can narrow down search results by:

  • Space
  • Team
  • Created date
  • Updated date

Article URLs

Each article is assigned a unique URL.

https://pinotwalk.com/orgs/{organization}/teams/{team}/spaces/{space}/blog/{article-id}

Share this URL to provide direct access to the article.
(Login may be required depending on visibility settings)

Import & Export

Export

You can download articles as Markdown files.

  1. Open the article
  2. "︙" menu → "Export"
  3. Select the format (Markdown / PDF)

Import

You can import Markdown files as articles.

  1. Click "Import" within a Space
  2. Select the file
  3. Confirm the title
  4. Click "Import"

Tips

Establish Naming Conventions

When using with a team, establishing naming conventions for Space names and article titles makes organization easier.

Examples:

  • [Project Name] Design Doc
  • YYYYMMDD_Meeting_Notes_Topic

Use Templates

It's convenient to save frequently used formats as templates.

Publishing & Sharing Settings {#publishing}

Visibility Types

You can set visibility for both articles and Spaces.

Setting Description Who Can View
Public Published on the internet Anyone
Team Same team members only Team members
Private Only yourself Author only

Article Visibility Settings

How to Set

  1. Open the article
  2. "︙" menu → "Settings"
  3. Select "Visibility"
  4. Click "Save"

Pre-Publication Checklist

Check the following before publishing:

  • [ ] Does it contain confidential information?
  • [ ] Are there any typos?
  • [ ] Do the links work correctly?
  • [ ] Are the images displaying?

Space Visibility Settings

Space visibility settings also affect articles within that Space.

Space Setting Impact on Articles
Public Can be set per article
Team Articles can only be Team or below
Private Articles can only be Private

Sharing Methods

Share via URL

You can copy and share the article URL.

  1. Open the article
  2. Copy the URL from the address bar
  3. Send via email or chat

For public articles, anyone with the URL can access them.

Share on Social Media

Public articles can be shared on social media.

  1. Open the article
  2. Click the "Share" button
  3. Select the social media platform you want to share to

Supported platforms: Twitter/X, Facebook, LinkedIn, etc.

Embed

You can embed public articles on other websites.

  1. Open the article
  2. "︙" menu → "Embed Code"
  3. Copy the code
  4. Paste into the destination HTML

Analytics

Public articles have basic analytics functionality.

Available information:

  • Page views (PV)
  • Unique users
  • Referrer sources

How to Check

  1. Open the article
  2. "︙" menu → "Analytics"

Important Notes

Editing After Publication

You can still edit articles after publication.
However, note that changes are reflected immediately.

About Deletion

Deleting a public article will invalidate its URL.
If external sites link to it, we recommend preparing an alternative landing page.

Be mindful of copyright for content you publish.
When quoting others' work, please cite the source appropriately.

Comments

None