Mémo Qiita de mes pensées
Aperçu
- Je veux pouvoir poster sur Qiita tout en prenant des notes localement.
- Je veux créer le mémo avec Sphinx et le rendre facile à consulter.
- Je veux pouvoir rechercher avec Alfred + Dash.
- Je veux écrire des notes dans Vim.
- Vous pouvez écrire en notation Markdown.
Mémo de construction d'environnement pour satisfaire le désir
Image de ce que vous voulez faire
- Prenez diverses notes avec Markdown
- Construisez avec Sphinx
- Afficher les documents Sphinx dans votre navigateur
- Publier de Kobito vers Qiita lors de la liaison de fichiers avec Kobito
- Recherchez rapidement des documents Sphinx à partir d'Alfred + Dash
environnement
-
OS X Marverics
-
Python2.7
-
virtualenv(virtualenvwrapper)
-
pip
-
Sphinx
-
homebrew
-
Pandoc
-
Apache
-
Kobito.app <= 1.9.2
-
"Lien de fichier externe" ne peut pas être utilisé temporairement pour la série Kobito 2.0
-
Dash.app
-
Alfred.app
Préparation
Quoi qu'il en soit, préparez un projet Sphinx
$ mkvirtualenv qiitanote #J'utilise virualenvwrapper
(qiitanote)$ pip install Sphinx
(qiitanote)$ mkdir qiitanote
(qiitanote)$ cd qiitanote
(qiitanote)$ sphinx-quickstarpt
#Vous pouvez entendre différentes choses dans le dialogue, donc si vous répondez un peu, la création est terminée
#essayez de faire du html
(qiitanote)$ make html
# _build/html/Le document HTML est généré ci-dessous
#Désactivez Virtualhost avec Apache et http://qiitanote.dev/alors_build/J'essaye de voir ci-dessous html
#Vérifiez le document(Chrome s'ouvre)
(qiitanote)$ open -a Google\ Chrome.app http://qiitanote.dev
Structure de répertoire initiale
qiitanote
├── Makefile
├── _build
│ ├── doctrees
│ └── html <-Le HTML est généré ici
├── _static
├── _templates
├── conf.py <-Fichier de configuration Sphinx
└── index.rst
Écrire dans Markdown
- Sphinx écrit des phrases dans la notation de base reStructuredText, mais envisagez de publier sur Qiita et d'écrire en Markdown.
- Utilisez l'extension du lien ci-dessous afin que le texte Markdown puisse également être construit avec Sphinx.
- Utiliser le format markdown pour les documents Sphinx
Pandoc Insco
(qiitanote)$ brew install pandoc
Paramètres d'extension
# conf.Réécrire py
#Ajout du contenu suivant
PROJECT_DIR = os.path.dirname(__file__)
sys.path.insert(0, PROJECT_DIR)
sys.path.insert(0, os.path.join(PROJECT_DIR, "libs")) #Script d'extension installé sous les bibliothèques
extensions += ["sphinxcontrib_markdown"]
markdown_title = 'Qiita Note'
source_suffix = '.md'
Créez un fichier .md et écrivez-le
(qiitanote)$ touch fisrtnote.md
Contenu
# My First Qiita Memo!!!
## 1. Hoge
hogehogehogehoge
hogehogehogehoge
## 2. Fuga
fugafugafugafuga
fugafugafugafuga
Construire
(qiitanote)$ make html
résultat
Travailler avec Kobito
Faire fonctionner les fichiers avec Kobito pour les publier sur Qiita
- Version de Kobito v1.7.0: vous pouvez maintenant lier des fichiers à partir de la ligne de commande!
(qiitanote)$ open -a Kobito firstnote.md
- Kobito s'ouvre et les fichiers sont liés. Vous pouvez poster en appuyant sur "Publier sur Qiita" tel quel
- C'est agréable de voir ce que vous avez édité avec vim en temps réel sur Kobito. Au contraire, le contenu édité par Kobito est reflété dans le fichier md.
- Puisqu'il est gênant d'appuyer sur la commande de lien à chaque fois, il sera lié automatiquement lorsque la création de code HTML sera terminée.
- Créez un script qui kidnappe les fichiers .md et frappe les commandes liées
# -*- coding: utf-8 -*-
import os
import time
import subprocess
TARGET_DIR = os.path.join(os.path.dirname(__file__), '..')
cmd = "open --hide -g -a Kobito {}"
# start Koibito.app
subprocess.call(cmd.format(""), shell=True)
time.sleep(3)
# associate .md file to Koibito.app
for root, dirs, files in os.walk(TARGET_DIR):
for f in files:
if f.endswith(".md"):
f = os.path.abspath(os.path.join(root, f))
subprocess.call(cmd.format(f), shell=True)
# hyde Kobito.app
subprocess.call(
"osascript -e 'tell application \"Finder\"'"
" -e 'set visible of process \"Kobito\" to false'"
" -e 'end tell'",
shell=True
)
- Enregistrer sous "libs / associé_kobito.py" etc.
- Si vous appuyez sur la commande de lien sans que Kobito ne soit en cours d'exécution, il sera double enregistré dans Kobito, alors démarrez-le d'abord et attendez un moment.
- C'est ennuyeux que Kobito vienne au premier plan à chaque fois que je crée du html, donc je cache la fenêtre quand j'ai terminé
Exécutez ce script lorsque vous "créez du HTML"
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
python libs/associate_kobito.py # <=ajouter à
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
Lorsque vous construisez avec cela, un mémo apparaîtra dans Kobito sans autorisation.
Configuration jusqu'à présent
qiitanote
├── Makefile
├── _build
│ ├── doctrees
│ └── html
├── _static
├── _templates
├── conf.py
├── firstnote.md
├── index.md # <-ajouter à
├── index.rst
└── libs
├── associate_kobito.py # <-ajouter à
└── sphinxcontrib_markdown.py # <-ajouter à
Rechercher avec Alfred + Dash
C'est un mémo que j'ai écrit, je veux donc le rechercher facilement à portée de main. Recherche à l'aide d'Alfred et Dash. J'ai acheté Alfred et Dash moyennant des frais.
- Référence ultra-rapide avec Alfred et dash-SlideShare
- Les paramètres sont omis
sphinxcontrib-dashbuilder facilite la transformation de documents Sphinx en Docsets pour Dash
Installation
(qiitanote)$ pip install sphinxcontrib-dashbuilder
Modifier le fichier de paramètres
# conf.py
extensions += ["sphinxcontrib_markdown", "sphinxcontrib.dashbuilder"]
dash_name = 'QiitaNote'
dash_icon_file = '_static/qiita.png' # <-favicon a été correctement apporté de Qiita
Réécriture de Makefile
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = _build
DOCSETSDIR = ~/Library/Application\ Support/Dash/DocSets/QiitaNote # <-ajouter à
~ abrégé ~
# .Dash ajouté à PHONY
.PHONY: dash help ...
~ abrégé ~
#Ajouter une cible de tableau de bord
dash:
$(SPHINXBUILD) -b dash $(ALLSPHINXOPTS) $(DOCSETSDIR)
@echo
@echo "Build finished. The Docset are in $(DOCSETSDIR)."
Construire
(qiitanote)$ make dash
Vérifiez avec Dash. Écran des paramètres du tableau de bord> Docsets> Appuyez sur le bouton Rescan
La note Qiita apparaît dans les ensembles de documents de Dash
Il est difficile d'appuyer sur "make dash" à chaque fois, donc build dash même lorsque "make html" est utilisé.
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
$(SPHINXBUILD) -b dash $(ALLSPHINXOPTS) $(DOCSETSDIR) # <-ajouter à
python libs/associate_kobito.py
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
Impossible de rechercher avec Alfred
- À ce rythme, vous ne pouvez pas rechercher à partir de la rubrique Hoge ou Alfred, par exemple.
- Dash recherche l'index de recherche à partir du fichier DocSets DB (sqlite).
- dashbuilder kidnappe l'index reST et écrit un fichier DB (sqlite).
- En d'autres termes, l'index reST est requis
Markdown-> reST Force le titre à indexer pendant la conversion.
## Hoge
## Fuga
Supposons qu'il existe une telle rubrique. Une fois converti en reST, procédez comme suit.
.. index:: Hoge
Hoge
----
.. index:: Fuga
Fuga
----
Ajoutez le traitement suivant à libs / sphinxcontrib_markdown.py.
48 # insert index directive
49 newlines = []
50 for line in source[0].split(u"\n"):
51 if self._is_heading_line(line):
52 prev = newlines[-1]
53 inedexline = u".. index:: {0}\n".format(prev)
54 newlines.insert(-1, inedexline)
55 newlines.append(line)
56 source[0] = "\n".join(newlines)
Maintenant, lorsque vous construisez à nouveau, vous pouvez trouver les en-têtes d'Alfred
Configuration jusqu'à présent
qiitanote
├── Makefile
├── _build
│ └── doctrees
├── _static
│ └── qiita.png # <-ajouter à
├── _templates
├── conf.py
├── firstnote.md
├── index.md
├── index.rst
└── libs
├── associate_kobito.py
└── sphinxcontrib_markdown.py
Changer l'apparence des documents Sphinx
- Je veux que ça ressemble à Qiita
- Dashbuilder désactive-t-il la recherche Sphinx lorsque je le mets dans le tableau de bord? -> Je ne veux pas de la colonne de gauche.
Utilisez mon thème sphinx.
(qiitanote)$ pip install sphinxjp.themes.basicstrap
Modifier les paramètres
# conf.py
extensions += ["sphinxcontrib_markdown", "sphinxcontrib.dashbuilder", 'sphinxjp.themes.basicstrap']
html_theme = 'basicstrap'
html_theme_options = {
'noheader': True,
'header_inverse': True,
'relbar_inverse': True,
'inner_theme': True,
'inner_theme_name': 'bootswatch-sandstone',
}
Construire
(qiitanote)$ make html
résultat
Livrables
C'est un peu différent de ce qui est écrit, mais je l'ai mis sur Github. S'il te plait accepte-le.
https://github.com/tell-k/qiitanote
TODO
- Je veux présenter oktavia pour que je puisse rechercher
Résumé
- Je suis sur le point d'écrire en Qiita.
- J'ai l'impression d'avoir écrit uniquement des choses qui n'ont pas grand-chose à voir avec Qiita
- Le reste attend ma motivation.
Post-scriptum (2014/10/18)
- Quand je viens de mettre à niveau Kobito vers 2.0, j'ai eu un historique indiquant que "la fonction de liaison de fichiers était temporairement désactivée" et elle s'est effondrée tôt. .. .. Kana
- Je ne savais pas comment créer un nouveau lien après l'annulation du lien de fichier, j'ai donc recréé l'article.
Recommended Posts