Skip to content

Instantly share code, notes, and snippets.

@HirotoShioi
Created December 12, 2018 07:51
Show Gist options
  • Save HirotoShioi/ca9026bf722021a96ad8f7d3b38a432a to your computer and use it in GitHub Desktop.
Save HirotoShioi/ca9026bf722021a96ad8f7d3b38a432a to your computer and use it in GitHub Desktop.
Current idea of structuring Scrapbox content data sample: https://scrapbox.io/toSrapbox/Get_started
Markdown
{ getMarkdown =
[ Simple
( ScrapText
{ getScrapText =
[ Scrap
{ scrapStyle = NoStyle
, scrapContent = [ PlainText "Get started" ]
}
]
}
)
, Thumbnail ( Url { getUrl = "https://gyazo.com/5f93e65a3b979ae5333aca4f32600611" } )
, Simple
( ScrapText
{ getScrapText =
[ Scrap
{ scrapStyle = NoStyle
, scrapContent = [ PlainText "Welcome to your new Scrapbox project!" ]
}
]
}
)
, BreakLine
, Header 2 [ PlainText "Everything is editable" ]
, BreakLine
, BulletLine 1
( ScrapText
{ getScrapText =
[ Scrap
{ scrapStyle = NoStyle
, scrapContent = [ PlainText "Click on any line and start typing to edit. " ]
}
]
}
)
, BreakLine
, BulletLine 2
( ScrapText
{ getScrapText =
[ Scrap
{ scrapStyle = NoStyle
, scrapContent = [ PlainText "Press tab at the beginning of a line to indent and add a bullet point." ]
}
]
}
)
, BreakLine
, BulletLine 1
( ScrapText
{ getScrapText =
[ Scrap
{ scrapStyle = NoStyle
, scrapContent = [ PlainText " Highlight text to make it a " ]
}
, Scrap
{ scrapStyle = NoStyle
, scrapContent = [ Link Nothing ( Url { getUrl = "New link" } ) ]
}
, Scrap
{ scrapStyle = NoStyle
, scrapContent = [ PlainText ", " ]
}
, Scrap
{ scrapStyle = Bold
, scrapContent = [ PlainText "bold" ]
}
, Scrap
{ scrapStyle = NoStyle
, scrapContent = [ PlainText ", " ]
}
, Scrap
{ scrapStyle = StrikeThrough
, scrapContent = [ PlainText "and" ]
}
, Scrap
{ scrapStyle = NoStyle
, scrapContent = [ PlainText " " ]
}
, Scrap
{ scrapStyle = Italic
, scrapContent = [ PlainText "more" ]
}
, Scrap
{ scrapStyle = NoStyle
, scrapContent = [ PlainText "." ]
}
]
}
)
, BulletLine 2
( ScrapText
{ getScrapText =
[ Scrap
{ scrapStyle = NoStyle
, scrapContent = [ PlainText "Add links while typing with a " ]
}
, Scrap
{ scrapStyle = NoStyle
, scrapContent = [ CodeNotation "#" ]
}
, Scrap
{ scrapStyle = NoStyle
, scrapContent = [ PlainText " before or brackets around " ]
}
, Scrap
{ scrapStyle = NoStyle
, scrapContent = [ CodeNotation "[" ]
}
, Scrap
{ scrapStyle = NoStyle
, scrapContent = [ PlainText "words you want to link " ]
}
, Scrap
{ scrapStyle = NoStyle
, scrapContent = [ CodeNotation "]" ]
}
]
}
)
, BreakLine
, Header 2 [ PlainText "Here is where it gets interesting " ]
, BreakLine
, BulletLine 1
( ScrapText
{ getScrapText =
[ Scrap
{ scrapStyle = NoStyle
, scrapContent = [ PlainText "Click a " ]
}
, Scrap
{ scrapStyle = NoStyle
, scrapContent = [ Link Nothing ( Url { getUrl = "New Link" } ) ]
}
, Scrap
{ scrapStyle = NoStyle
, scrapContent = [ PlainText " to create a new page with that title and open it." ]
}
]
}
)
, BreakLine
, Simple
( ScrapText
{ getScrapText =
[ Scrap
{ scrapStyle = NoStyle
, scrapContent = [ PlainText "Click related thumbnails in the footer of any page to explore ideas you have linked." ]
}
]
}
)
, BulletLine 2
( ScrapText
{ getScrapText =
[ Scrap
{ scrapStyle = NoStyle
, scrapContent = [ PlainText "Pages that are directly linked or two steps away from the current page will be displayed." ]
}
]
}
)
, BreakLine
, BulletLine 1
( ScrapText
{ getScrapText =
[ Scrap
{ scrapStyle = NoStyle
, scrapContent = [ PlainText "See images, videos, and external links added inside " ]
}
, Scrap
{ scrapStyle = NoStyle
, scrapContent = [ CodeNotation "[" ]
}
, Scrap
{ scrapStyle = NoStyle
, scrapContent = [ PlainText " brackets" ]
}
, Scrap
{ scrapStyle = NoStyle
, scrapContent = [ CodeNotation "]" ]
}
, Scrap
{ scrapStyle = NoStyle
, scrapContent = [ PlainText " on the page" ]
}
]
}
)
, BreakLine
, BlockQuote
( ScrapText
{ getScrapText =
[ Scrap
{ scrapStyle = NoStyle
, scrapContent = [ PlainText "Our goal is to help you build a map of your ideas that gains clarity and context with every scrap you add. " ]
}
]
}
)
, BreakLine
, BreakLine
, Header 1 [ PlainText "What can you put in a Scrapbox project?" ]
, BulletLine 1
( ScrapText
{ getScrapText =
[ Scrap
{ scrapStyle = NoStyle
, scrapContent = [ PlainText "Use Scrapbox to outline ideas, discuss " ]
}
, Scrap
{ scrapStyle = NoStyle
, scrapContent = [ CodeNotation "code blocks" ]
}
, Scrap
{ scrapStyle = NoStyle
, scrapContent = [ PlainText ", give feedback, and brainstorm. " ]
}
]
}
)
, BreakLine
, BulletLine 1
( ScrapText
{ getScrapText =
[ Scrap
{ scrapStyle = NoStyle
, scrapContent = [ PlainText "For example" ]
}
]
}
)
, BulletLine 1
( ScrapText
{ getScrapText =
[ Scrap
{ scrapStyle = NoStyle
, scrapContent = [ PlainText "Lets say you are working on developing a new website. You might want to discuss ideas with your team before and while you execute the plan. First create a page " ]
}
, Scrap
{ scrapStyle = NoStyle
, scrapContent = [ CodeNotation "Site plan" ]
}
, Scrap
{ scrapStyle = NoStyle
, scrapContent = [ PlainText " to start a conversation about the site requirements and link some useful resources. On that page you might add a link for a new page called " ]
}
, Scrap
{ scrapStyle = NoStyle
, scrapContent = [ CodeNotation "Social media buttons" ]
}
, Scrap
{ scrapStyle = NoStyle
, scrapContent = [ PlainText "." ]
}
]
}
)
, BreakLine
, BulletLine 1
( ScrapText
{ getScrapText =
[ Scrap
{ scrapStyle = NoStyle
, scrapContent = [ PlainText "You can immediately click on that link to `Social media buttons` and start editing. There you may add links to " ]
}
, Scrap
{ scrapStyle = NoStyle
, scrapContent = [ CodeNotation "Social media buttons" ]
}
, Scrap
{ scrapStyle = NoStyle
, scrapContent = [ PlainText " and start editing. There you may add links to " ]
}
, Scrap
{ scrapStyle = NoStyle
, scrapContent = [ CodeNotation "Twitter" ]
}
, Scrap
{ scrapStyle = NoStyle
, scrapContent = [ PlainText ", " ]
}
, Scrap
{ scrapStyle = NoStyle
, scrapContent = [ CodeNotation "Facebook" ]
}
, Scrap
{ scrapStyle = NoStyle
, scrapContent = [ PlainText ", etc. Next you can click on " ]
}
, Scrap
{ scrapStyle = NoStyle
, scrapContent = [ CodeNotation "Twitter" ]
}
, Scrap
{ scrapStyle = NoStyle
, scrapContent = [ PlainText " and you'll see a related link that will take you back to " ]
}
, Scrap
{ scrapStyle = NoStyle
, scrapContent = [ CodeNotation "Site Plan" ]
}
, Scrap
{ scrapStyle = NoStyle
, scrapContent = [ PlainText ". " ]
}
]
}
)
, BreakLine
, Simple
( ScrapText
{ getScrapText =
[ Scrap
{ scrapStyle = NoStyle
, scrapContent = [ PlainText "Once you can easily and directly type your ideas while also building context ideas become more clear the more you use it. No more folders full of dead text means no more teams isolated from their own ideas." ]
}
]
}
)
, BreakLine
, BlockQuote
( ScrapText
{ getScrapText =
[ Scrap
{ scrapStyle = Italic
, scrapContent = [ PlainText "What ideas in your head could your team benefit from you putting down right now? Go create your first three or so pages and add a few links. From 3 to 3,000 pages your ideas will only grow in context." ]
}
]
}
)
, BreakLine
, BreakLine
, Header 2 [ PlainText "📌 Once you've got the basics, here are ways to dig deeper and get the most out of your new project " ]
, Simple
( ScrapText
{ getScrapText =
[ Scrap
{ scrapStyle = NoStyle
, scrapContent = [ PlainText " See a list of all the " ]
}
, Scrap
{ scrapStyle = NoStyle
, scrapContent = [ Link ( Just "Things you can do" ) ( Url { getUrl = "https://scrapbox.io/help/Things%20you%20can%20do" } ) ]
}
, Scrap
{ scrapStyle = NoStyle
, scrapContent = [ PlainText " " ]
}
]
}
)
, BulletLine 1
( ScrapText
{ getScrapText =
[ Scrap
{ scrapStyle = NoStyle
, scrapContent = [ PlainText "Includes more syntax, inviting team members, and creating profiles" ]
}
]
}
)
, BreakLine
, BreakLine
, BulletLine 1
( ScrapText
{ getScrapText =
[ Scrap
{ scrapStyle = NoStyle
, scrapContent = [ PlainText "See some " ]
}
, Scrap
{ scrapStyle = NoStyle
, scrapContent = [ Link ( Just "Example projects" ) ( Url { getUrl = "https://scrapbox.io/help/exampless" } ) ]
}
, Scrap
{ scrapStyle = NoStyle
, scrapContent = [ PlainText " " ]
}
]
}
)
, BulletLine 2
( ScrapText
{ getScrapText =
[ Scrap
{ scrapStyle = NoStyle
, scrapContent = [ PlainText "Includes a SaaS startup, design agency, and more" ]
}
]
}
)
, BreakLine
, BulletLine 1
( ScrapText
{ getScrapText =
[ Scrap
{ scrapStyle = NoStyle
, scrapContent = [ PlainText "See " ]
}
, Scrap
{ scrapStyle = NoStyle
, scrapContent = [ Link ( Just "How-tos and support" ) ( Url { getUrl = "https://scrapbox.io/help/" } ) ]
}
, Scrap
{ scrapStyle = NoStyle
, scrapContent = [ PlainText " " ]
}
]
}
)
, BulletLine 2
( ScrapText
{ getScrapText =
[ Scrap
{ scrapStyle = NoStyle
, scrapContent = [ PlainText "For detailed instructions and answers to FAQs" ]
}
]
}
)
, BreakLine
, BreakLine
, Header 1 [ PlainText "We would love to hear any questions or feedback you may have" ]
, Simple
( ScrapText
{ getScrapText =
[ Scrap
{ scrapStyle = NoStyle
, scrapContent = [ PlainText "Please let us know if you have any suggestions, questions, or points of friction.You can contact us directly by email: [email protected], " ]
}
, Scrap
{ scrapStyle = NoStyle
, scrapContent = [ Link ( Just "twitter" ) ( Url { getUrl = "https://twitter.com/scrapboxapp" } ) ]
}
, Scrap
{ scrapStyle = NoStyle
, scrapContent = [ PlainText ", and " ]
}
, Scrap
{ scrapStyle = NoStyle
, scrapContent = [ Link ( Just "facebook" ) ( Url { getUrl = "https://facebook.com/scrapboxapp" } ) ]
}
]
}
)
, BreakLine
, Simple
( ScrapText
{ getScrapText =
[ Scrap
{ scrapStyle = Italic
, scrapContent = [ PlainText "Thank you for using Scrapbox!" ]
}
]
}
)
, BreakLine
, BreakLine
, BlockQuote
( ScrapText
{ getScrapText =
[ Scrap
{ scrapStyle = NoStyle
, scrapContent = [ PlainText "Note: When you're done reading you might change the title of this page to 'Welcome to project-name' and add some personalized instructions for your team." ]
}
]
}
)
]
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment