aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJesús <heckyel@hyperbola.info>2020-01-10 15:50:21 -0500
committerJesús <heckyel@hyperbola.info>2020-01-10 15:50:21 -0500
commit7a2b1ce8f83af095ec97c117c3729fce725fbcfd (patch)
treed245ac05351e340d323854dde8323f7fe2d4e3dc
parenta30cd5ca2658c7ff9a7e70c85ad5a5b9ad95bf4d (diff)
downloademmet-mode-7a2b1ce8f83af095ec97c117c3729fce725fbcfd.tar.lz
emmet-mode-7a2b1ce8f83af095ec97c117c3729fce725fbcfd.tar.xz
emmet-mode-7a2b1ce8f83af095ec97c117c3729fce725fbcfd.zip
add support docs
-rw-r--r--.gitignore1
-rw-r--r--Makefile12
-rw-r--r--README.md11
3 files changed, 19 insertions, 5 deletions
diff --git a/.gitignore b/.gitignore
index a33fc04..ef5f81c 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,5 +1,6 @@
memo*
*.elc
+README.txt
/emmet-mode.el
/src/snippets.el
/src/preferences.el
diff --git a/Makefile b/Makefile
index dd3493a..16b59ce 100644
--- a/Makefile
+++ b/Makefile
@@ -1,5 +1,8 @@
DST=emmet-mode.el
+# set markdown input format to "markdown-smart" for pandoc version 2 and to "markdown" for pandoc prior to version 2
+MARKDOWN = $(shell if [ `pandoc -v | head -n1 | cut -d" " -f2 | head -c1` = "2" ]; then echo markdown-smart; else echo markdown; fi)
+
all: emmet-mode.el emmet-mode.elc
emmet-mode.el: src/snippets.el src/preferences.el src/*
@@ -26,12 +29,15 @@ src/preferences.el: conf/preferences.json
tools/json2hash conf/preferences.json -o src/preferences.el --defvar 'emmet-preferences'
clean:
- rm -f emmet-mode.elc emmet-mode.el src/snippets.el src/preferences.el
+ rm -f emmet-mode.elc emmet-mode.el README.txt src/snippets.el src/preferences.el
test: emmet-mode.el
emacs --quick --script src/test.el
-docs:
- echo docs
+README.txt: README.md
+ pandoc -f $(MARKDOWN) -t plain README.md -o README.txt
+
+docs: README.txt
+ @echo generated docs
.PHONY: all test docs clean
diff --git a/README.md b/README.md
index 395e10b..48adb79 100644
--- a/README.md
+++ b/README.md
@@ -566,5 +566,12 @@ For further information and demo see [Emmet's documentation](https://docs.emmet.
When working on emmet-mode. It is generated from the files in the `/src` directory by `make`.
- make clean
- make
+ $ make clean && make
+
+Require `pandoc` for generate README.txt
+
+ # pacman -S pandoc
+
+then run:
+
+ $ make docs