基本的な書き方とフォーマットの構文 - GitHub Docs
見出し 見出しを作成するには、1 つから 6 つの # シンボルを見出しのテキストの前に追加します。 使用する # の個数によって、見出しの階層レベルと書体のサイズが決まります。 # A first-level heading ## A second-level heading ### A third-level heading 2 つ以上の見出しを使用すると、GitHub では自動的に目次が生成されます。この目次には、ファイル ヘッダー内の をクリックするとアクセスできます。 各見出しのタイトルが目次に一覧表示され、タイトルをクリックして選択したセクションに移動できます。 テキストのスタイル設定 コメント フィールドと .md ファイルでは、太字、斜体、取り消し線、下付き、上付きのテキストで強調を示すことができます。 スタイル構文キーボード ショートカット例出力
Markdown-itのプラグインの作り方
先日、VSCode ではてなブログの記事を書きやすくするための拡張機能を作りました。 開発時のあれこれは別の記事にも書いています。 さて、VSCode 拡張機能の Markdown プレビューはextendMarkdownItという関数を定義するだけで拡張することが出来ます。 import * as vscode from 'vscode'; export function activate(context: vscode.ExtensionContext) { return { extendMarkdownIt(md: any) { return md.use(require('markdown-it-emoji')); } }; } "markdown-it-emoji"のようなプラグインを作って差し込むだけで、VSCode の Markdown を拡張できます。 これを使って拡張機能
React マークダウンを HTML 変換するライブラリ試してみた - かもメモ
マークダウンテキストを HTML 表示するライブラリ試してみたのでメモ 結論 React で使うなら React-markdown がシンプルで良さそう 調査経緯 ライブラリとしては marked >>> markdown-it > remark の順で使われている remark の内部で使われている remark-parse が圧倒的に多く使われている 最終更新は markdown-it > remark (remark-parse) > marked の順 marked は利用数は多いのですが最終アップデートが 11 年前なので、Markdown-it と Remark で検討することにしました Markdown-it Remark Project JavaScript TypeScript Star 14.5k 5.8k Last publish 7 months ago a yea
mdxjs.com
Markdown for the component eraMDX lets you use JSX in your markdown content. You can import components, such as interactive charts or alerts, and embed them within your content. This makes writing long-form content with components a blast. 🚀 Continue reading » New: MDX 3!A small major this time, nothing big, which is also nice sometimes! This mainly drops support for old Node (use 16 or later), a
GitHubのREADMEの見た目をイケてる感じにする
どうも、hanetsukiです。 GitHubにはアカウントそれぞれにREADMEを乗せられるリポジトリがついているのはご存知でしょうか？ 以前から簡易的なプロフィールは掲載していたのですが、訪問していただいた方に「おっ！」っと思わせるようなREADMEにしたいと思い更新することにしました。 今回更新するにあたって何を使ったのかというのを忘備録的に残していきます。 これが今回完成したREADME 詳しいソースコードは、リポジトリをご覧ください。 Skill Icons 自分が持っているスキルなどを表示するときに便利。 他にもお気に入りの言語や、今学習の言語という使い方もできそうですね！ 詳しい利用方法は、https://github.com/tandpfun/skill-icons#readme をご覧ください Badge Generator Zennのフォロワー数の記載に利用しています。
Build optimized websites quickly, focus on your content | Docusaurus
Build optimized websites quickly, focus on your content Powered by MDXSave time and focus on text documents. Simply write docs and blog posts with MDX, and Docusaurus builds them into static HTML files ready to be served. You can even embed React components in your Markdown thanks to MDX. Built Using ReactExtend and customize your project's layout by writing React components. Leverage the pluggabl
Markdownでシーケンス図とかが書けるMermaid記法で業務フローを書いたら意外とイケたので自分なりのコツを紹介してみる | DevelopersIO
こんにちは、臼田です。 みなさん、業務設計してますか？(挨拶 今回はMarkdownでシーケンス図やフローチャートなどの図を記述できるMermaidを使って業務フローを書いてみたら、意外と書けたので自分なりのTipsを紹介したいと思います。 その前に 注意点として、まだMermaidを使い始めたばかりなので、「もっとこうしたらいいぞ」とか「こっちのほうがいいぞ」とかあれば建設的なフィードバックとしてSNSとかでいただけるとありがたいです。 あと業務フローって表現しましたが、人によって思い描く業務フローが違うと思うので、業務フローの定義に関するツッコミはご容赦ください。私が今回Mermaidで書いたのは以下の図です。(内容はブログ用に簡素化しました) この図のコードは以下のとおりです。(後ほど解説します) sequenceDiagram autonumber actor お客様 partic
【効率化】Notionで使えるマークダウンとショートカットまとめ｜ラゾログ！
このような疑問にお答えします。 Notionでノートやメモをとると、色を変えたりレイアウトしたり、ノートを見やすく出来ます。 ただ、文字を選択してメニューを押してと、1つ変更するのにも数アクション必要です。 そこでNotionには、マークダウン記法と呼ばれるテキストエディタで利用できる記法の一部と、独自のショートカットが用意されているのですが、これらにはあまり使わないものも多いです。 今回本記事では、数あるショートカットの中でも、よく利用するものを紹介していきます。 これらを使いながら覚える事で、Notionでのノートテイキングを大幅に効率化する事ができますよ！ それではいきます。 マークダウンスタイル マークダウン記法をご存知でしょうか？ マークダウンは文章の書き方の1つです。 太字は**で囲む、箇条書きは行頭に – を付けるのように、決められたルールに従い文章を書くことで効率化を図れま
Notionで「見出しのトグル化」機能が利用可能になりました #notion | DevelopersIO
小ネタです。 Notionのアップデートで「見出しをトグル付きで利用可能になった」というものがリリースされていたので試してみました。 最新情報 What’s New? Headings + toggles = ? pic.twitter.com/mofvOp4GzB — Notion (@NotionHQ) December 23, 2021 目次 実践 スラッシュコマンド(/toggle)を使う コマンド(>)を使う メニューから選ぶ 既存見出しコンテンツをトグル化する ブロックタイプを変換する まとめ 実践 「トグル」とは、ブロックに対して使える機能で、ひとまとまりのコンテンツを階層毎に開いたり畳んだり出来るものです。 今回の新機能は、これが「Notionにおける見出し」に対して利用出来るようになったというものです。対象は以下見出しレベルとなっています。 見出しレベル1(#) 見出しレ
高速で Markdown を HTML に変換してくれる『markdown-wasm』を使ってみた
はじめに 今回は, MOONGIFT さんで紹介されていた『markdown-wasm』について紹介します. その名の通り WebAssembly を使っているとのことでかなり高速で動くみたいです. まだ細かい検証はできていないんですが, 備忘録として概要と導入方法について紹介します. 『markdown-wasm』とは？ 『markdown-wasm』は, C のコードを WebAssembly に移植した超高速な Markdown パーサーです. 主な特徴は以下です. 依存関係なし(31 kB gzipped) どこでも実行ができ, かつ安全(WebAssembly なので分離されたメモリで実行できる) シンプルな API とても速い md4c(C で作られた Markdown parser) をベースに作られている - (CommonMark の仕様に準拠) 速度面では, 公式ページ
GitHubのMarkdownファイルでMermaid記法がサポートされたので作図まとめてみました。 - Qiita
Mermaid1はコードで作図することができるツールです。 いままではmermaid.jsが必要でしたが、今回GitHubのMarkdownファイルで、Mermaid記法がサポートされました。 それに伴い、Mermaidで表現できる図についてまとめてみました。 なお簡単にMermaidを試す方法として、Live Editor2もあります。 可能な作図一覧 フローチャート（Flowchart） graph TD A[Christmas] -->|Get money| B(Go shopping) B --> C{Let me think} C -->|One| D[Laptop] C -->|Two| E[iPhone] C -->|Three| F[fa:fa-car Car] sequenceDiagram Alice->>+John: Hello John, how are you?
Include diagrams in your Markdown files with Mermaid
EngineeringOpen SourceInclude diagrams in your Markdown files with MermaidA picture tells a thousand words. Now you can quickly create and edit diagrams in markdown using words with Mermaid support in your Markdown files. A picture tells a thousand words, but up until now the only way to include pictures and diagrams in your Markdown files on GitHub has been to embed an image. We added support for
NotionヘッドレスCMS化記録 (2) ページプロパティの読み取りとMarkdown生成 | Marginalia
前回に引き続き、今回はNotion APIで取得したページのデータから記事のMarkdownファイルを生成するまでに苦労した点を書いていきたい。 ページプロパティの読み取り前回は Notion 公式のJavaScript向けクライアントライブラリ（以下 @notionhq/client) を使ってページやブロックのデータを取得した。 https://github.com/makenotion/notion-sdk-js 最終的に Hugo で記事としてビルド可能なMarkdownファイルを生成するためには、記事のタイトルやタグなどを保持する Frontmatter 情報と、記事の本文の情報の両方を Notion のページから読み取って変換しなければならない。 しかしこれも思いどおりにはいかず、いくつかの工夫が必要だった。 ページプロパティオブジェクトのキーがIDじゃない前回の記事で Pag
ブラウザでコード譜を書く : "fumen" の紹介 - Qiita
あらまし ブラウザでコード譜を書くためのMarkdownベースのJavascriptライブラリ fumen の紹介です。 Github : https://github.com/hbjpn/fumen/ ドキュメント : https://hbjpn.github.io/fumen/ プレイグラウンド : https://fumenbook.com/ Wordpress Plugin: https://wordpress.org/plugins/fumen/ ずいぶん前(2013年〜)から公開していましたが、以前のバージョンは速度が遅かったり描画の純軟性にかける問題があったので、根本的な作り直しを行いました。また、fumenをコアにしたコード譜作成WEBサービスfumenbookも作りました。 モチベーション 譜面を作るツールは多くあるのですが、音符等まで含めた綺麗な譜面を作ることを主眼にお
Slidevを導入してMarkdownで美しいスライドを書こう - Qiita
(PR) 本記事でご紹介している Slidev などのテクニックについて、2021/11/20(土) 開催の VS Code Conference Japan 2021 にてご紹介しました。YouTubeアーカイブや発表資料も是非ご参照ください。 Slidevとは Slidevはエンジニア向けプレゼンテーションツールです。 Markdownで記述した文書から美しいスライドを生成できます。 公式デモ とそのソースとなるMarkdown もご参照ください。 ドキュメントは以下にあります。 すぐに使えるサンプル 使用頻度の高いと思われる記法を含めたサンプルのMarkdownを以下に公開しています。 コピペするなどしてお使いください。詳細は後述します。 上記Markdownを使用しているスライドを以下にデプロイしています。 上記Markdownの記述内容と見比べていただけると分かりやすいかと思いま
【無料運用】Zennの投稿記事を使ったブログをNext.js, Tailwindcss, TypeScript, Vercelで構築した。
最初に Reactのチュートリアル、Next.jsのチュートリアル、TypeScriptの入門?を終えたので、そのアウトプットとして無料で運用出来るtechBlogを作成しようと思う。記事は新しくブログ用に書くとZennと分散してしまうのでZennに投稿している記事を使ってサイトをビルドしていく。その前、準備としてZennとGitHubを連携する必要があるのでまだ行っていない方はこちらの記事を参考にすると出来ます。 実際に作成したtechBlog モバイル版 デスクトップ版 techBlog：大学生だった 実際のコード 参考にしたデザイン MNW- mobile 構成 Next.js index.tsx 記事をzennの投稿を管理しているリポジトリから取得する。 TypeScriptでAPIの型を定義する。 [id].tsx コードのシンタックスハイライト、数式、テーブルを表示する。 co
GatsbyJSのscriptタグの扱いについて ~Markdown内のscriptタグはエスケープ処理されます~
GatsbyJSのscriptタグの扱いについて ~Markdown内のscriptタグはエスケープ処理されます~ 2020-05-17 2019-12-26 GatsbyJSを使ってみて地味に詰まったポイントがscriptタグの扱いでした。 僕のようになんとなくjavascriptを使い始めた方もいるかもしれないので、今回はGatsbyJSでのscriptタグに関する注意点について書いてみました。 Markdownファイルに書き込んだScriptタグは実行されないまず最初はこれです。 サブタイトルにも書きましたが、GatsbyではMarkdown中のScriptタグはエスケープ処理されてしまうため実行されません。 Markdown中のscriptタグを実行させるには、専用に作られたプラグインを導入するか、自分でそれように作り込む必要があります。 プラグインについてはTwitterやYou
Hugo で静的なサイト・ブログを構築しよう - Qiita
Deleted articles cannot be recovered. Draft of this article would be also deleted. Are you sure you want to delete this article? この記事について この記事は Hugo でブログを始めようとしている方へ向けた Hugo 入門記事となっており、Hugo による静的なブログの構築・運用方法 を簡単にですが紹介します。 Hugo の Awesome は以下をどうぞ。 Awesome Hugo - 有用なリンクまとめ - Qiita 動的サイトから静的サイトへ WordPress で構築する、というのが長らくブログ運用の主流でした。もちろん現在も多くのサイトが WordPress によって運用されていますが、最近では「 静的サイト 」という選択肢も広まってきています。(調
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
GitHub - scaffdog/scaffdog: :dog: scaffdog is Markdown driven scaffolding tool.
GitHub - jonschlinkert/gray-matter: Smarter YAML front matter parser, used by metalsmith, Gatsby, Netlify, Assemble, mapbox-gl, phenomic, vuejs vitepress, TinaCMS, Shopify Polaris, Ant Design, Astro, hashicorp, garden, slidev, saber, sourcegraph, and many
