Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
711 commits
Select commit Hold shift + click to select a range
6e04d77
move into docs subdir: mkdir docs, git mv man1 man3 man9 docs
mhaberler May 18, 2016
4a3fbf9
add-frontmatter Python script
mhaberler May 18, 2016
9a8d3ac
apply conversion: find . -name '*.asciidoc' -exec scripts/addfm.py {…
mhaberler May 18, 2016
c4a64b0
move to docs/man
mhaberler May 18, 2016
4c5a491
Merge remote-tracking branch 'static/man-subdir-filtered' into clean-…
mhaberler May 18, 2016
d8ca8ef
_config.yml: exclude manpage extensions
mhaberler May 18, 2016
c6e0df9
nah.. fix _config.yml
mhaberler May 18, 2016
263f9d1
more of same. This SUCKS.
mhaberler May 18, 2016
f96aa26
remove nroff source files.
mhaberler May 18, 2016
43d92ea
add jenkins status icon
mhaberler May 18, 2016
df0e935
Update README.md
mhaberler May 18, 2016
25c6488
Update README.md
mhaberler May 18, 2016
28c3292
Update README.md
mhaberler May 18, 2016
46206f6
Update README.md
mhaberler May 18, 2016
b1c92ad
clenaup: exlcude, remove more files so they do not seep into _site
mhaberler May 18, 2016
ae7f340
Scripted indexes for man pages
ArcEye May 18, 2016
7b9a41d
Auto generation man page indexes - Pt2
ArcEye May 18, 2016
87d6f8f
Update README.md
mhaberler May 18, 2016
9515852
Pointless edit to trigger rebuild and test Makefile
ArcEye May 19, 2016
27c88b5
Test absolute address in links
ArcEye May 19, 2016
53fdfd2
Change relative includes to abs links
ArcEye May 19, 2016
3361a2f
Revert abs path changes to index-gen script
ArcEye May 19, 2016
c20a8fa
Revert absolute links changes in index-HAL.asciidoc
ArcEye May 19, 2016
a4ae99d
fix man index path
mhaberler May 19, 2016
3572ec4
docs: add man categories
mhaberler May 19, 2016
07419dd
man section names: do not overflow right column
mhaberler May 19, 2016
54056b5
Remove old index to components
ArcEye May 19, 2016
5aefe8b
index-HAL - remove man references
mhaberler May 19, 2016
03fd55a
gitignore generated index files
mhaberler May 19, 2016
0a8af00
fix broken links
mhaberler May 19, 2016
9ba1453
fix some more links
mhaberler May 19, 2016
4d83bda
and some more
mhaberler May 19, 2016
92216e6
and some more
mhaberler May 19, 2016
f074255
remove typos
mhaberler May 19, 2016
a8331ce
Create Sandbox for ad hoc contributions
ArcEye May 20, 2016
23e62af
Test article into Sandbox
ArcEye May 20, 2016
1a4f2ed
Test Article for Sandbox
ArcEye May 20, 2016
1ed89d7
SandBox tidy up
ArcEye May 20, 2016
49e60a5
Rename sandbox template files names to numbers to aid scripting
ArcEye May 20, 2016
2385253
Add scripts/filenums
ArcEye May 20, 2016
b6d20f5
Added index.asciidoc updating to filenums script
ArcEye May 20, 2016
1e02e80
Update sitemap generation to produce absolute URLs
ArcEye May 21, 2016
e45d549
Change SandBox URL to absolute to ensure it works from anywhere
ArcEye May 21, 2016
31863ef
Fix broken links
ArcEye May 21, 2016
acc1f77
Link fix Pt 2
ArcEye May 21, 2016
7daf947
Links fix Pt3
ArcEye May 21, 2016
2d4ddc2
Links fix 4
ArcEye May 21, 2016
7fe302e
All link errors have been removed, but 8 which relate to the same
ArcEye May 21, 2016
f9718a2
No easy way into the Developing docs
ArcEye May 22, 2016
54afffe
Keep forgetting jekyll creates dirs instead of files
ArcEye May 22, 2016
fc69099
docs sidebar: add sections and shuffle subjects around
luminize May 22, 2016
4aac9b4
develop-index.asciidoc: add bullets to increase readablilty
luminize May 22, 2016
6a72a03
Merge pull request #22 from luminize/clean-jekyll-1
luminize May 22, 2016
06d3f33
Edit link name
ArcEye May 23, 2016
2b995f5
Switch order of topics in 'For Starters' doc side bar
ArcEye May 23, 2016
7fb9b28
Merge pull request #74 from mhaberler/clean-jekyll-1
luminize May 24, 2016
d007ac1
fixup edit-repo and edit-branch to point to mk/mk-docs
mhaberler May 24, 2016
8bfb97e
analytics.html: include only if production site is built
mhaberler May 25, 2016
fbc33aa
Merge pull request #75 from machinekit/analytics-on-production-only
luminize May 25, 2016
ca34c47
fix icons, and trigger a merge event
mhaberler May 25, 2016
7089682
New CSE preparation
ArcEye May 25, 2016
4d77ae3
New CSE and google verification details required pre-indexing
ArcEye May 25, 2016
69a2fd3
Merge pull request #83 from ArcEye/master
luminize May 25, 2016
0b7dece
New search engine refs for site
ArcEye May 25, 2016
035b8a4
Merge pull request #84 from ArcEye/master
luminize May 25, 2016
6c8287b
hardwired site refs: drop
mhaberler May 25, 2016
b15230c
scripts: recursive replace example
mhaberler May 25, 2016
14e441d
_config.yml: remove url:
mhaberler May 25, 2016
7c92af2
fix "wiki.machinekit.org" links
mhaberler May 25, 2016
845a5fc
fix a few broken links
mhaberler May 26, 2016
338b77d
Merge pull request #85 from mhaberler/relative-links
ArcEye May 26, 2016
94db8d3
use edit-me to patch this up ;)
mhaberler May 26, 2016
bf14af0
Merge pull request #87 from machinekit/mhaberler-patch-4
ArcEye May 26, 2016
5e3fbba
remove unused html directory
mhaberler May 26, 2016
399667d
add a default linkcheckerrc so it can be pointed to with --config=/sc…
mhaberler May 26, 2016
b37a5d7
replace docs/* link:../ with link:/docs
mhaberler May 26, 2016
ee24179
make :imagesdir: paths absolute
mhaberler May 26, 2016
d6c2e2c
remove CNAME in topdir - should be inserted build-time
mhaberler May 26, 2016
929ae37
fix some more bad image links
mhaberler May 26, 2016
0849376
Merge pull request #88 from mhaberler/relative-links
luminize May 26, 2016
fa1a405
more link unbreaking - unsure how this escapes the linkchecker
mhaberler May 26, 2016
f6aa837
Merge pull request #89 from mhaberler/relative-links
ArcEye May 26, 2016
9794e18
switch Google Analytics ID from preview.machinekit.io to www.machinek…
mhaberler May 26, 2016
b420d66
one more..
mhaberler May 26, 2016
9487134
Merge pull request #90 from mhaberler/relative-links
mhaberler May 26, 2016
a6588e5
one more of own turds..
mhaberler May 26, 2016
95ae102
README: add reference to site
luminize May 27, 2016
c506ce0
docs/README: remove obsolete file
luminize May 27, 2016
b58320f
Merge pull request #91 from luminize/fix-readme
mhaberler May 27, 2016
9968baa
docs/basic_hal.asciidoc: make diagram example and improve `net`
luminize May 27, 2016
41fb25e
Merge pull request #92 from luminize/improve-net
mhaberler May 27, 2016
ecc22e8
fix images dirs
mhaberler May 27, 2016
58fb6ae
Update basic_hal.asciidoc
mhaberler May 27, 2016
0e9bf32
Update to SandBox blurb
ArcEye May 27, 2016
510d771
Makefile: minimal rebuild - dont touch asciidoc files if not necessary
mhaberler May 28, 2016
4a9c58c
Merge pull request #93 from machinekit/ArcEye-patch-1
mhaberler May 28, 2016
65ec8a6
Merge pull request #95 from mhaberler/dev
luminize May 28, 2016
812440b
fix hal_exit(3)
mhaberler May 28, 2016
151993c
Update hal_init.3hal.asciidoc
mhaberler May 28, 2016
ddfbd47
Merge pull request #100 from machinekit/mhaberler-patch-5
mhaberler May 28, 2016
2fd9ec7
Merge pull request #98 from machinekit/mhaberler-patch-3
mhaberler May 28, 2016
b4db64f
Update hal_create_thread.3hal.asciidoc
mhaberler May 28, 2016
2a4a03a
Merge pull request #101 from machinekit/mhaberler-patch-6
mhaberler May 28, 2016
d76293a
Update halrun.1.asciidoc
mhaberler May 29, 2016
3ddfddb
Merge pull request #102 from machinekit/mhaberler-patch-8
mhaberler May 29, 2016
96162ef
start over on docs/documenting/diagramtest example
mhaberler May 29, 2016
897a2ac
Update building-rt-preempt-kernel.asciidoc
ArcEye May 29, 2016
1d9129f
Merge pull request #107 from machinekit/mhaberler-patch-9
mhaberler May 29, 2016
b899431
Merge pull request #108 from machinekit/ArcEye-patch-1
mhaberler May 29, 2016
484f433
now diagramtest fixups with edit-this-page..
mhaberler May 29, 2016
6ffd566
Merge pull request #109 from machinekit/mhaberler-patch-10
mhaberler May 29, 2016
e0c42dc
enable youtube, asciinema, toc plugins
mhaberler May 29, 2016
39d3d49
Merge pull request #111 from machinekit/mhaberler-patch-1
mhaberler May 29, 2016
d1a442a
demo asciinema, youtube (broken), gist
mhaberler May 29, 2016
7261b1b
Merge pull request #112 from machinekit/mhaberler-patch-2
mhaberler May 29, 2016
e3fa4ef
end passthrough block properly
mhaberler May 29, 2016
770a915
Merge pull request #113 from machinekit/mhaberler-patch-3
luminize May 29, 2016
3a340f8
edit-me: add picture picture
luminize May 29, 2016
07936f0
documenting.asciidoc: update instructions edit-me link
luminize May 29, 2016
ad93e75
dragramtest: rename to diagram-examples
luminize May 29, 2016
6a23841
diagramtest: rename to diagram-examples
luminize May 29, 2016
7b6e2f0
documenting: update index, links and examples
luminize May 29, 2016
b43f6d3
Merge pull request #114 from luminize/edit-me-instructions
mhaberler May 29, 2016
043bb2c
cleanup: remove out-of-date buildbot information
luminize May 30, 2016
dc2b1ec
highlighting: import jekyll-pygments-themes
mhaberler May 30, 2016
3bebbcf
_config.yml: set pygments as default highlighter, style
mhaberler May 30, 2016
1e6e3ae
diagram-examples: fix source highlighting
mhaberler May 30, 2016
d19d952
Merge pull request #115 from mhaberler/master
luminize May 30, 2016
aa1a787
docs/site/about-this-site: first cut
mhaberler May 30, 2016
4c0813b
touchups
mhaberler May 30, 2016
34e9067
Merge pull request #116 from mhaberler/master
mhaberler May 30, 2016
7fcdcc8
add sandbox, issues, a bit of howto
mhaberler May 30, 2016
28042d0
Merge pull request #122 from mhaberler/master
mhaberler May 30, 2016
97c25b9
touchups
mhaberler May 30, 2016
ec6100d
Merge pull request #123 from mhaberler/master
mhaberler May 30, 2016
2a8d623
Merge pull request #125 from luminize/remove-buildbot-info
cdsteinkuehler May 30, 2016
673fe6c
_data/docs.yml: add reference to "about-this-site"
luminize May 30, 2016
d76cda5
Merge pull request #127 from luminize/nav-about-this-site
ArcEye May 30, 2016
ece24be
improve examples
mhaberler May 30, 2016
081ee38
add missing plugins
mhaberler May 30, 2016
08e8810
Merge pull request #129 from mhaberler/master
mhaberler May 30, 2016
dcabd22
add Guardfile for livereload
mhaberler May 30, 2016
f03500b
scripts/serve.sh: run the jeykyll-asciidoctor stack for serving in a …
mhaberler May 30, 2016
816090a
plugins: touchups
mhaberler May 30, 2016
88ebe07
diagram-examples: touchups
mhaberler May 30, 2016
028fcec
Merge pull request #130 from mhaberler/master
luminize May 30, 2016
c0bf9bd
nah. unbug serve.sh
mhaberler May 30, 2016
7effee2
Merge pull request #131 from mhaberler/master
luminize May 30, 2016
cfe2f09
Update about-this-site.asciidoc
ArcEye May 31, 2016
549a521
Merge pull request #136 from machinekit/ArcEye-patch-1
mhaberler May 31, 2016
17b734e
do not overspecify intra-site URI's
mhaberler May 31, 2016
27fe05e
Merge pull request #138 from machinekit/mhaberler-patch-4
luminize May 31, 2016
5031763
Update instcomp.asciidoc
ArcEye May 31, 2016
1026088
Merge pull request #139 from machinekit/ArcEye-patch-1
luminize May 31, 2016
77a94c8
tickle build
mhaberler Jun 1, 2016
e8aac69
Merge pull request #149 from machinekit/mhaberler-patch-1
mhaberler Jun 1, 2016
bb6dc40
Add RPi 2/3
koppi Jun 1, 2016
1c1d109
Merge pull request #152 from koppi/patch-1
ArcEye Jun 1, 2016
87813dc
Overhaul the indexes
ArcEye Jun 1, 2016
9a832b0
Merge pull request #154 from ArcEye/master
luminize Jun 2, 2016
f032489
Update to Integrator and Documenting Indexes
ArcEye Jun 2, 2016
87caef5
Merge pull request #156 from ArcEye/master
luminize Jun 3, 2016
2d52827
Modify style sheet to achieve proper contrast between text and backgr…
ArcEye Jun 3, 2016
a52c04d
Merge pull request #157 from ArcEye/master
luminize Jun 3, 2016
1a5d98e
Fix visibility of some [NOTE] banners
ArcEye Jun 4, 2016
1ecd39f
Merge pull request #158 from ArcEye/master
cdsteinkuehler Jun 4, 2016
d1caa16
Fully document Axis GUI enhancements
ArcEye Jun 5, 2016
ae8f4d1
Merge pull request #159 from ArcEye/master
cdsteinkuehler Jun 5, 2016
f7698ea
Updated imagesdir to reflect path of images folder
Jun 6, 2016
61050f3
Fixed image paths in halui_examples
Jun 6, 2016
c1fb702
Fixed images pahts in pyvpc_examples
Jun 6, 2016
b0717b6
Merge pull request #160 from DuNuNuBatman/master
luminize Jun 6, 2016
30c2652
some repair on gladevcp.asciidoc
mhaberler Jun 6, 2016
11a08bf
Merge pull request #161 from mhaberler/gladevcp
luminize Jun 6, 2016
023ff6d
gcode.asciidoc: this commented FIXME section breaks the page
luminize Jun 7, 2016
3c30a70
Merge pull request #162 from luminize/gcode-fix
mhaberler Jun 7, 2016
9860a8c
basic_hal.asciidoc: now correctly documents 64 bit floats
evanmj Jun 8, 2016
44f46d1
Merge pull request #163 from evanmj/patch-1
mhaberler Jun 8, 2016
62e94e9
diagram-examples.asciidoc: add PlantUML examples
luminize Jun 8, 2016
2ecc201
Merge pull request #164 from luminize/plantuml
cdsteinkuehler Jun 8, 2016
522d981
Makefile: support different output formats
mhaberler Jun 14, 2016
72d6749
scripts/asciidoc.mustache: a start - this is still markdown
mhaberler Jun 14, 2016
dc8c822
Merge pull request #57 from mhaberler/asciidoc-support
ArcEye Jun 15, 2016
c123a4a
add Python examples and install README
machinekoder Jun 15, 2016
31afa09
Update README.md
machinekoder Jun 15, 2016
a292fb0
Merge pull request #58 from strahlex/python-examples
mhaberler Jun 15, 2016
55b3c6d
add support for livereload if Jekyll environment=development
mhaberler Jun 16, 2016
ed1f3bf
fix plugins.asciidoc
mhaberler Jun 16, 2016
ddb3949
deprecate old search links
mhaberler Jun 16, 2016
161a3bd
Merge pull request #165 from machinekit/mhaberler-patch-1
ArcEye Jun 16, 2016
b82201b
Merge pull request #142 from mhaberler/master
ArcEye Jun 16, 2016
b30e223
Update asciidoc.mustache
ArcEye Jun 17, 2016
05de663
Merge pull request #60 from machinekit/ArcEye-patch-1
mhaberler Jun 17, 2016
6726be1
Update APT-packages-jessie.asciidoc
Jun 17, 2016
a3a93f4
Merge pull request #167 from HakanBastedt/patch-1
mhaberler Jun 18, 2016
45e96c6
Squashed 'machinetalk-protobuf/' content from commit 05de663
mhaberler Jun 19, 2016
ccb4f50
Merge commit '45e96c69bf0546b7c88a4cdeafc5a418347f0a37' as 'machineta…
mhaberler Jun 19, 2016
017ce0a
Makefile: make template path configurable, depend on all moving parts
mhaberler Jun 19, 2016
d0ae94c
scripts/gen-proto-docs.sh: pass along template path
mhaberler Jun 19, 2016
16f70d3
scripts/machinekit-docs.mustache: keep template in mk-docs repo
mhaberler Jun 19, 2016
c709b55
_config.yml: ignore machinetalk-protobuf subtree
mhaberler Jun 19, 2016
e58cf29
Makefile: generate protobuf.asciidoc from template and subtree
mhaberler Jun 19, 2016
314b080
Merge pull request #62 from mhaberler/master
luminize Jun 19, 2016
b3bc7b4
Squashed 'machinetalk-protobuf/' changes from 05de663..314b080
mhaberler Jun 19, 2016
914c86b
Merge commit 'b3bc7b47d79f24ccc1f910b23f7cfcc6f700b474'
mhaberler Jun 19, 2016
27dd8a8
protobuf.asciidoc: generate target path
mhaberler Jun 19, 2016
c004a69
Merge pull request #169 from mhaberler/master
luminize Jun 19, 2016
d231724
Add 'machinetalk-protobuf/' from commit '314b0803559666489a794d6518a5…
mhaberler Jun 19, 2016
6463e9b
scripts/gen-proto-docs.sh: pass along template path
mhaberler Jun 19, 2016
b894811
scripts/machinekit-docs.mustache: keep template in mk-docs repo
mhaberler Jun 19, 2016
10f31ad
_config.yml: ignore machinetalk-protobuf subtree
mhaberler Jun 19, 2016
284f47d
Makefile: generate protobuf.asciidoc from template and subtree
mhaberler Jun 19, 2016
9bf215e
protobuf.asciidoc: generate target path
mhaberler Jun 19, 2016
eb16d6c
tickle build
mhaberler Jun 19, 2016
0295480
Merge pull request #170 from mhaberler/master
luminize Jun 20, 2016
b52146d
diagram-examples: move highlighting to separate page, adapt links
mhaberler Jun 20, 2016
6a36a0f
tickle build
mhaberler Jun 20, 2016
aeb6330
Merge pull request #171 from mhaberler/master
ArcEye Jun 20, 2016
3e2e06f
diagrams: make wavedrom use svg instead of png, link to article
mhaberler Jun 20, 2016
1d69033
Merge pull request #172 from machinekit/wavedrom-svg
ArcEye Jun 20, 2016
f394c20
Add QtQuickVcp documentation to site docs
ArcEye Jun 21, 2016
95342a2
Shorten First level title
ArcEye Jun 21, 2016
e1a8b88
Merge pull request #175 from ArcEye/master
luminize Jun 21, 2016
c0f4a74
python-interface: touch up
mhaberler Jun 23, 2016
061cb89
Merge pull request #176 from mhaberler/master
luminize Jun 23, 2016
7d688cd
kick website-production jenkins job
mhaberler Jun 23, 2016
2a4626b
Move Search-Bar to primary navigation items for all pages
ArcEye Jun 25, 2016
d997ac1
hal_pru_generic: import man page from Charles' repo
mhaberler Jun 25, 2016
701a614
hal_pru_generic: cosmetic touchups
mhaberler Jun 25, 2016
6fda7da
Merge pull request #179 from ArcEye/master
mhaberler Jun 25, 2016
b9180af
Merge pull request #180 from mhaberler/master
ArcEye Jun 25, 2016
c913cc2
infra: a first stab at repos & flows descriptions
mhaberler Jun 25, 2016
64b308a
Merge pull request #181 from mhaberler/master
ArcEye Jun 25, 2016
a39b2fa
Capitalise and shorten top level header title
ArcEye Jun 25, 2016
900f8d0
fix typo in Makefile
mhaberler Jun 25, 2016
6c7242c
Amend docs_contents to exclude from google searches
ArcEye Jun 25, 2016
7dae766
Merge pull request #182 from machinekit/ArcEye-patch-1
mhaberler Jun 25, 2016
423632a
Delete edittest-adxl345.asciidoc
mhaberler Jun 25, 2016
50888df
Merge pull request #183 from ArcEye/master
mhaberler Jun 25, 2016
c668118
Merge pull request #184 from machinekit/mhaberler-patch-1
ArcEye Jun 25, 2016
6ccb858
diagram-examples: add Google Charts example
mhaberler Jun 26, 2016
4f005d5
infra: clarify which repos are involved
mhaberler Jun 26, 2016
e141582
index-documenting: fix title
mhaberler Jun 26, 2016
b7cec6f
repositiories: fix typos, expand on mksocfpga, jenkins
mhaberler Jun 26, 2016
7174653
fix typo
mhaberler Jun 26, 2016
640587f
Merge pull request #185 from mhaberler/master
luminize Jun 26, 2016
8ce72a6
Move `Edit This Page` and `Sandbox` links to navigation area
ArcEye Jun 26, 2016
2142eef
Merge pull request #186 from ArcEye/master
mhaberler Jun 26, 2016
9415531
Update gcode.asciidoc
machinekoder Jul 13, 2016
5856161
Merge pull request #188 from machinekit/strahlex-patch-1
ArcEye Jul 13, 2016
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
9 changes: 9 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
_site/
test/
.DS_Store
*.adoc
*.*~
.jekyll-metadata
docs/man/man1/index.asciidoc
docs/man/man3/index.asciidoc
docs/man/man9/index.asciidoc
5 changes: 5 additions & 0 deletions Guardfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
guard 'livereload' do
watch(%r{_site/.+})
end


43 changes: 43 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# see http://www.cmcrossroads.com/ask-mr-make/6535-tracing-rule-execution-in-gnu-make
# to trace make execution of make in more detail:
# make VV=1
ifeq ("$(origin VV)", "command line")
OLD_SHELL := $(SHELL)
SHELL = $(warning Building $@$(if $<, (from $<))$(if $?, ($? newer)))$(OLD_SHELL)
endif
# Delete the default suffix rules
.SUFFIXES:
.PHONY: all

TEMPLATE:= $(shell pwd)/scripts/machinekit-docs.mustache

all: docs/man/man1/index.asciidoc \
docs/man/man3/index.asciidoc \
docs/man/man9/index.asciidoc \
docs/machinetalk/protobuf.asciidoc

# this should be made minimal
# scripts/filenums


# all asciidoc documents in this repo
MAN1 := $(filter-out docs/man/man1/index.asciidoc, $(wildcard docs/man/man1/*.asciidoc))
MAN3 := $(filter-out docs/man/man3/index.asciidoc, $(wildcard docs/man/man3/*.asciidoc))
MAN9 := $(filter-out docs/man/man9/index.asciidoc, $(wildcard docs/man/man9/*.asciidoc))

docs/man/man1/index.asciidoc: $(MAN1)
scripts/index-gen.sh man1 'HAL Utilities and GUIs'

docs/man/man3/index.asciidoc: $(MAN3)
scripts/index-gen.sh man3 'RTAPI and HAL Functions'

docs/man/man9/index.asciidoc: $(MAN9)
scripts/index-gen.sh man9 'HAL Components'

docs/machinetalk/protobuf.asciidoc: \
machinetalk-protobuf/src/machinetalk/protobuf/*.proto \
$(TEMPLATE) \
machinetalk-protobuf/Makefile \
scripts/gen-proto-docs.sh
scripts/gen-proto-docs.sh $(TEMPLATE)

45 changes: 0 additions & 45 deletions README.asciidoc

This file was deleted.

11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Website Build Status [![Website Build Status](https://jenkins.machinekit.io/buildStatus/icon?job=website-production)](https://jenkins.machinekit.io/view/machinekit/job/website-production/)

Website PR Builder Status [![Website PR Build Status](https://jenkins.machinekit.io/buildStatus/icon?job=website-preview)](https://jenkins.machinekit.io/job/website-preview)

Manpage Build Status: [![Manpage Build Status](https://jenkins.machinekit.io/buildStatus/icon?job=machinekit-manpages)](https://jenkins.machinekit.io/job/machinekit-manpages/)

# Machinekit Documentation

This repository contains the source for the Machinekit website and
documentation which are available at [machinekit.io/docs](http://www.machinekit.io/docs/)

68 changes: 68 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
name: Machinekit
highlighter: pygments
relative_permalinks: false
permalink: /blog/:year/:month/:day/:title/
markdown: kramdown
repository: https://github.com/machinekit/machinekit

gems:
- jekyll-asciidoc
- asciidoctor-diagram
- jekyll-sitemap
- jekyll-asciinema
- jekyll-youtube
- jekyll-toc
- jekyll-gist
- jekyll-seo-tag
- jekyll-mermaid
- jekyll-plantuml

#url: http://machinekit.io
baseurl: /

asciidoc: asciidoctor
asciidoc_ext: asciidoc,ad

asciidoctor:
safe: 0
attributes:
- hardbreaks!
- source-highlighter=pygments
- pygments-css=pastie

#incremental: yes

defaults:
-
scope:
path: ""
values:
edit-repo: "https://github.com/machinekit/machinekit-docs/"
edit-branch: "master"
-
scope:
# applies to all files under:
path: "docs"
values:
layout: "docs"
docs-dir: "docs"


# stage manpage sources here for comparison
exclude: [Makefile,
Guardfile,
staging,
scripts,
src,
machinetalk-protobuf,
README.md,
'*/*.1',
'*/*.1.in',
'*/*.3hal',
'*/*.3rtapi',
'*/*.9' ]

# for www.machinekit.io
google_analytics: UA-48383649-1


4 changes: 4 additions & 0 deletions _config_devel.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# this will include livereload support in the rendered HTML
# see _includes/livreload.html

environment: development
7 changes: 7 additions & 0 deletions _data/community.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
- title: community
community:
- home
- channels
- c4
- contributing
- maintainers
26 changes: 26 additions & 0 deletions _data/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
- title: For starters
docs:
- site/about-this-site
- index-getting-started
- index-user
- index-HAL
- getting-help

- title: Developing
docs:
- index-integrator
- index-developer
- index-documenting
- developing/develop-index
- developing/qtquickvcp

- title: Manpages
docs:
- man/man1
- man/man3
- man/man9

- title: Project Infrastructure
docs:
- infra/repositories

17 changes: 17 additions & 0 deletions _includes/analytics.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{% if jekyll.environment == "production" %}
{% if site.google_analytics_id %}
<!-- Google Analytics (http://google.com/analytics) -->
<script>
var _gaq = _gaq || [];
_gaq.push(['_setAccount', '{{ site.google_analytics_id }}']);
_gaq.push(['_setDomainName', '{{ site.url }}']); // Multiple sub-domains
_gaq.push(['_setAllowLinker', true]); // Multiple TLDs
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
{% endif %}
{% endif %}
9 changes: 9 additions & 0 deletions _includes/community_contents.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<div class="unit one-fifth hide-on-mobiles">
<aside>
{% for section in site.data.community %}
<h4>{{ section.title }}</h4>
{% include community_ul.html items=section.community %}
{% endfor %}
{% include edit-me.html %}
</aside>
</div>
10 changes: 10 additions & 0 deletions _includes/community_contents_mobile.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<div class="community-nav-mobile unit whole show-on-mobiles">
<select onchange="if (this.value) window.location.href=this.value">
<option value="">Navigate community…</option>
{% for section in site.data.community %}
<optgroup label="{{ section.title }}">
{% include community_option.html items=section.community %}
</optgroup>
{% endfor %}
</select>
</div>
11 changes: 11 additions & 0 deletions _includes/community_option.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{% assign items = include.items %}

{% for item in items %}
{% assign item_url = item | prepend:"/community/" | append:"/" %}

{% for p in site.pages %}
{% if p.url == item_url %}
<option value="{{ site.url }}{{ p.url }}">{{ p.title }}</option>
{% endif %}
{% endfor %}
{% endfor %}
21 changes: 21 additions & 0 deletions _includes/community_ul.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{% assign items = include.items %}

<ul>
{% for item in items %}
{% assign item_url = item | prepend:"/community/" | append:"/" %}

{% if item_url == page.url %}
{% assign c = "current" %}
{% else %}
{% assign c = "" %}
{% endif %}

{% for p in site.pages %}
{% if p.url == item_url %}
<li class="{{ c }}"><a href="{{ site.url }}{{ p.url }}">
{{ p.title }}</a></li>
{% endif %}
{% endfor %}

{% endfor %}
</ul>
Binary file not shown.
Loading