\n
\n );\n}\n","import * as preact from \"preact\";\n/** @jsx preact.h */\n\n// TODO :: restore highlight\n/*function highlightText(search, text) {\n if (settings.highlightTerms) {\n var pattern = new RegExp(\n `(${search})`,\n settings.highlightEveryTerm ? \"gi\" : \"i\"\n );\n text = text.replace(\n pattern,\n '$1'\n );\n }\n\n return text;\n}*/\n\nexport default function Result({ settings, item }) {\n let text;\n if (item.text) {\n text = item.text\n .split(\" \")\n .slice(0, settings.descriptiveWords)\n .join(\" \");\n if (\n item.text.length < text.length &&\n text.charAt(text.length - 1) !== \".\"\n ) {\n text += \" ...\";\n }\n }\n\n return (\n - \n {start > 0 && (\n
- \n
- \n
\n
\n );\n}\n","import * as preact from \"preact\";\n\nimport Pagination from \"./Pagination\";\nimport Result from \"./Result\";\nimport {\n textSearchNoResults,\n textSearchOneCharacterOrMore,\n textSearchOneResult,\n textSearchResults,\n textSearchShouldBeXOrMore,\n textSearchTooShort\n} from \"./translation\";\n\n/** @jsx preact.h */\n\nexport default class Search extends preact.Component {\n constructor(props) {\n super(props);\n\n this.state = {\n search: this.props.settings.field.value || \"\",\n start: 0\n };\n }\n\n // \"click\", \".SearchResults__close\"\n handleClose = () => {\n this.props.onClose();\n };\n\n scrollTop = () => {\n if (this.resultRef) {\n this.resultRef.scrollTop = 0;\n }\n };\n\n handlePaginate = start => {\n this.setState({ start }, this.scrollTop);\n };\n\n handleChange = event => {\n this.setState({ search: event.target.value, start: 0 }, this.scrollTop);\n\n this.props.settings.field.value = event.target.value;\n };\n\n getResults() {\n const { settings } = this.props;\n const { start } = this.state;\n\n const warnings = [];\n let counter = 0;\n let results = [];\n\n if (this.state.search.length < settings.minimumLength) {\n warnings.push(textSearchTooShort);\n warnings.push(\n settings.minimumLength === 1\n ? textSearchOneCharacterOrMore\n : textSearchShouldBeXOrMore.replace(\n \"!min\",\n settings.minimumLength\n )\n );\n\n return { warnings, counter, results, start };\n }\n\n const found = this.props.onSearch(this.state.search);\n\n counter = found.length;\n\n if (counter === 0) {\n warnings.push(textSearchNoResults);\n return { warnings, counter, results, start };\n }\n\n if (settings.showTitleCount) {\n this.props.onTitleChange(`(${counter})`);\n }\n\n results = found.filter(\n (item, itemNumber) =>\n itemNumber >= start && itemNumber < settings.show + start\n );\n\n return { warnings, counter, results, start };\n }\n\n render() {\n const { settings } = this.props;\n const { warnings, counter, results, start } = this.getResults();\n\n return (\n \n {item.title}\n
\n {settings.showURL && (\n \n )}\n {text && {text}
}\n \n \n (this.resultRef = el)}\n >\n \n ×\n \n
\n \n );\n }\n}\n","import * as preact from \"preact\";\nimport FlexSearch from \"flexsearch\";\n\nimport Search from \"./Search\";\n\n/** @jsx preact.h */\n\nconst originalTitle = document.title;\n\nfunction getURLP(name) {\n const elements = new RegExp(`[?|&]${name}=([^&;]+?)(&|#|;|$)`).exec(\n window.location.search\n );\n\n return (\n decodeURIComponent(\n ((elements && elements[1]) || \"\").replace(/\\+/g, \"%20\")\n ) || null\n );\n}\n\nclass SearchEngine {\n constructor(options) {\n this.settings = {\n field: document.getElementById(\"search_input\"),\n show: 10,\n showURL: true,\n showTitleCount: true,\n minimumLength: 3,\n descriptiveWords: 25,\n highlightTerms: true,\n highlightEveryTerm: false,\n contentLocation: \"daux_search_index.json\",\n ...options\n };\n\n this.searchIndex = {\n pages: []\n };\n }\n\n loadData() {\n if (!this.loadingPromise) {\n this.loadingPromise = fetch(\n this.settings.base_url + this.settings.contentLocation\n )\n .then(data => data.json())\n .then(json => {\n this.searchIndex = new FlexSearch({\n doc: {\n id: \"url\",\n field: [\"title\", \"text\", \"tags\"]\n }\n });\n\n let pages = json.pages;\n\n // Only keep the pages related to the current language\n if (window.searchLanguage) {\n const pagePrefix = `${window.searchLanguage}/`;\n pages = pages.filter(\n item => item.url.indexOf(pagePrefix) === 0\n );\n }\n\n this.searchIndex.add(pages);\n });\n }\n\n return this.loadingPromise;\n }\n\n run() {\n if (getURLP(\"q\")) {\n this.settings.field.value = getURLP(\"q\");\n\n this.loadData().then(() => {\n this.displaySearch();\n });\n }\n\n this.settings.field.addEventListener(\"keyup\", event => {\n // Start loading index once the user types text in the field, not before\n this.loadData();\n\n if (parseInt(event.keyCode, 10) === 13) {\n this.loadData().then(() => {\n this.displaySearch();\n });\n }\n });\n }\n\n keyUpHandler = e => {\n if (e.which === 27) {\n //escape\n this.handleClose();\n }\n };\n\n handleClose = () => {\n document.title = originalTitle;\n\n document.removeEventListener(\"keyup\", this.keyUpHandler);\n\n document.body.classList.remove(\"with-search\");\n preact.render(null, this.resultContainer);\n this.resultContainer = null;\n };\n\n displaySearch() {\n if (!this.resultContainer) {\n this.resultContainer = document.createElement(\"div\");\n document.body.appendChild(this.resultContainer);\n }\n\n document.addEventListener(\"keyup\", this.keyUpHandler);\n\n preact.render(\n \n {counter === 1\n ? textSearchOneResult\n : textSearchResults.replace(\"!count\", counter)}\n
\n {warnings.map(warning => (\n \n {warning}\n
\n ))}\n {results.map(result => (\n \n
\n );\n}\n","import * as preact from \"preact\";\n/** @jsx preact.h */\n\n// TODO :: restore highlight\n/*function highlightText(search, text) {\n if (settings.highlightTerms) {\n var pattern = new RegExp(\n `(${search})`,\n settings.highlightEveryTerm ? \"gi\" : \"i\"\n );\n text = text.replace(\n pattern,\n '$1'\n );\n }\n\n return text;\n}*/\n\nexport default function Result({ settings, item }) {\n let text;\n if (item.text) {\n text = item.text\n .split(\" \")\n .slice(0, settings.descriptiveWords)\n .join(\" \");\n if (\n item.text.length < text.length &&\n text.charAt(text.length - 1) !== \".\"\n ) {\n text += \" ...\";\n }\n }\n\n return (\n - \n {start > 0 && (\n
- \n
- \n
\n
\n );\n}\n","import * as preact from \"preact\";\n\nimport Pagination from \"./Pagination\";\nimport Result from \"./Result\";\nimport {\n textSearchNoResults,\n textSearchOneCharacterOrMore,\n textSearchOneResult,\n textSearchResults,\n textSearchShouldBeXOrMore,\n textSearchTooShort\n} from \"./translation\";\n\n/** @jsx preact.h */\n\nexport default class Search extends preact.Component {\n constructor(props) {\n super(props);\n\n this.state = {\n search: this.props.settings.field.value || \"\",\n start: 0\n };\n }\n\n // \"click\", \".SearchResults__close\"\n handleClose = () => {\n this.props.onClose();\n };\n\n scrollTop = () => {\n if (this.resultRef) {\n this.resultRef.scrollTop = 0;\n }\n };\n\n handlePaginate = start => {\n this.setState({ start }, this.scrollTop);\n };\n\n handleChange = event => {\n this.setState({ search: event.target.value, start: 0 }, this.scrollTop);\n\n this.props.settings.field.value = event.target.value;\n };\n\n getResults() {\n const { settings } = this.props;\n const { start } = this.state;\n\n const warnings = [];\n let counter = 0;\n let results = [];\n\n if (this.state.search.length < settings.minimumLength) {\n warnings.push(textSearchTooShort);\n warnings.push(\n settings.minimumLength === 1\n ? textSearchOneCharacterOrMore\n : textSearchShouldBeXOrMore.replace(\n \"!min\",\n settings.minimumLength\n )\n );\n\n return { warnings, counter, results, start };\n }\n\n const found = this.props.onSearch(this.state.search);\n\n counter = found.length;\n\n if (counter === 0) {\n warnings.push(textSearchNoResults);\n return { warnings, counter, results, start };\n }\n\n if (settings.showTitleCount) {\n this.props.onTitleChange(`(${counter})`);\n }\n\n results = found.filter(\n (item, itemNumber) =>\n itemNumber >= start && itemNumber < settings.show + start\n );\n\n return { warnings, counter, results, start };\n }\n\n render() {\n const { settings } = this.props;\n const { warnings, counter, results, start } = this.getResults();\n\n return (\n \n {item.title}\n
\n {settings.showURL && (\n \n )}\n {text && {text}
}\n \n \n (this.resultRef = el)}\n >\n \n ×\n \n
\n \n );\n }\n}\n","import * as preact from \"preact\";\nimport FlexSearch from \"flexsearch\";\n\nimport Search from \"./Search\";\n\n/** @jsx preact.h */\n\nconst originalTitle = document.title;\n\nfunction getURLP(name) {\n const elements = new RegExp(`[?|&]${name}=([^&;]+?)(&|#|;|$)`).exec(\n window.location.search\n );\n\n return (\n decodeURIComponent(\n ((elements && elements[1]) || \"\").replace(/\\+/g, \"%20\")\n ) || null\n );\n}\n\nclass SearchEngine {\n constructor(options) {\n this.settings = {\n field: document.getElementById(\"search_input\"),\n form: document.getElementById(\"search_form\"),\n show: 10,\n showURL: true,\n showTitleCount: true,\n minimumLength: 3,\n descriptiveWords: 25,\n highlightTerms: true,\n highlightEveryTerm: false,\n contentLocation: \"daux_search_index.js\",\n ...options\n };\n\n this.searchIndex = {\n pages: []\n };\n }\n\n loadData() {\n if (!this.loadingPromise) {\n // We do this as jsonp instead of an XHR or fetch request\n // to be compatible with usage from filesystem\n const po = document.createElement(\"script\");\n po.type = \"text/javascript\";\n po.async = true;\n po.src = this.settings.base_url + this.settings.contentLocation;\n const s = document.getElementsByTagName(\"script\")[0];\n s.parentNode.insertBefore(po, s);\n\n this.loadingPromise = new Promise(resolve => {\n window.load_search_index = data => resolve(data);\n }).then(json => {\n this.searchIndex = new FlexSearch({\n doc: {\n id: \"url\",\n field: [\"title\", \"text\", \"tags\"]\n }\n });\n\n let pages = json.pages;\n\n // Only keep the pages related to the current language\n if (window.searchLanguage) {\n const pagePrefix = `${window.searchLanguage}/`;\n pages = pages.filter(\n item => item.url.indexOf(pagePrefix) === 0\n );\n }\n\n this.searchIndex.add(pages);\n });\n }\n\n return this.loadingPromise;\n }\n\n run() {\n if (getURLP(\"q\")) {\n this.settings.field.value = getURLP(\"q\");\n\n this.loadData().then(() => {\n this.displaySearch();\n });\n }\n\n this.settings.field.addEventListener(\"keyup\", event => {\n // Start loading index once the user types text in the field, not before\n this.loadData();\n\n if (parseInt(event.keyCode, 10) === 13) {\n this.loadData().then(() => {\n this.displaySearch();\n });\n }\n });\n\n this.settings.form.addEventListener(\"submit\", event => {\n event.preventDefault();\n this.loadData().then(() => {\n this.displaySearch();\n });\n });\n }\n\n keyUpHandler = e => {\n if (e.which === 27) {\n //escape\n this.handleClose();\n }\n };\n\n handleClose = () => {\n document.title = originalTitle;\n\n document.removeEventListener(\"keyup\", this.keyUpHandler);\n\n document.body.classList.remove(\"with-search\");\n preact.render(null, this.resultContainer);\n this.resultContainer = null;\n };\n\n displaySearch() {\n if (!this.resultContainer) {\n this.resultContainer = document.createElement(\"div\");\n document.body.appendChild(this.resultContainer);\n }\n\n document.addEventListener(\"keyup\", this.keyUpHandler);\n\n preact.render(\n \n {counter === 1\n ? textSearchOneResult\n : textSearchResults.replace(\"!count\", counter)}\n
\n {warnings.map(warning => (\n \n {warning}\n
\n ))}\n {results.map(result => (\n pass ... prompt''' ``` -**Python's profiler output** - - 261917242 function calls in 686.251 CPU seconds - - ncalls tottime filename:lineno(function) - 152824 513.894 {method 'sort' of 'list' objects} - 129590630 83.894 rrule.py:842(__cmp__) - 129590630 82.439 {cmp} - 153900 1.296 rrule.py:399(_iter) - 304393/151570 0.963 rrule.py:102(_iter_cached) - - -**Ruby** - - class A < B; def self.create(object = User) object end end - class Zebra; def inspect; "X#{2 + self.object_id}" end end - - module ABC::DEF - include Comparable - - # @param test - # @return [String] nothing - def foo(test) - Thread.new do |blockvar| - ABC::DEF.reverse(:a_symbol, :'a symbol', :<=>, 'test' + test) - end.join - end - - def [](index) self[index] end - def ==(other) other == self end - end - - anIdentifier = an_identifier - Constant = 1 - render action: :new - -**Haml** - - !!! XML - %html - %body - %h1.jumbo{:id=>"a", :style=>'font-weight: normal', :title=>title} highlight.js - /html comment - -# ignore this line - %ul(style='margin: 0') - -items.each do |i| - %i= i - = variable - =variable2 - ~ variable3 - ~variable4 - The current year is #{DataTime.now.year}. - -**Perl** - - # loads object - sub load - { - my $flds = $c->db_load($id,@_) || do { - Carp::carp "Can`t load (class: $c, id: $id): '$!'"; return undef - }; - my $o = $c->_perl_new(); - $id12 = $id / 24 / 3600; - $o->{'ID'} = $id12 + 123; - #$o->{'SHCUT'} = $flds->{'SHCUT'}; - my $p = $o->props; - my $vt; - $string =~ m/^sought_text$/; - $items = split //, 'abc'; - for my $key (keys %$p) - { - if(${$vt.'::property'}) { - $o->{$key . '_real'} = $flds->{$key}; - tie $o->{$key}, 'CMSBuilder::Property', $o, $key; - } - } - $o->save if delete $o->{'_save_after_load'}; - return $o; - } - - =head1 NAME - POD till the end of file - -**PHP** - - require_once 'Zend/Uri/Http.php'; - - abstract class URI extends BaseURI - { - - /** - * Returns a URI - * - * @return URI - */ - static public function _factory($stats = array(), $uri = 'http') - { - $uri = explode(':', $uri, 0b10); - $schemeSpecific = isset($uri[1]) ? $uri[1] : ''; - $desc = 'Multi - line description'; - - // Security check - if (!ctype_alnum($scheme)) { - throw new Zend_Uri_Exception('Illegal scheme'); - } - - return [ - 'uri' => $uri, - 'value' => null, - ]; - } - } - - __halt_compiler () ; datahere - datahere - datahere */ - datahere - -**Scala** - - object abstractTypes extends Application { - abstract class SeqBuffer { - type T; val element: Seq[T]; def length = element.length - } - } - - /** Turn command line arguments to uppercase */ - object Main { - def main(args: Array[String]) { - val res = for (a <- args) yield a.toUpperCase - println("Arguments: " + res.toString) - } - } - - /** Maps are easy to use in Scala. */ - object Maps { - val colors = Map("red" -> 0xFF0000, - "turquoise" -> 0x00FFFF, - "black" -> 0x000000, - "orange" -> 0xFF8040, - "brown" -> 0x804000) - def main(args: Array[String]) { - for (name <- args) println( - colors.get(name) match { - case Some(code) => - name + " has code: " + code - case None => - "Unknown color: " + name - } - ) - } - } - -**Go** - - package main - - import ( - "fmt" - "rand" - "os" - ) - - const ( - Sunday = iota - Partyday - numberOfDays // this constant is not exported - ) - - type Foo interface { - FooFunc(int, float32) (complex128, []int) - } - - // simple comment - type Bar struct { - os.File /* multi - line - comment */ - - PublicData chan int - } - - func main() { - ch := make(chan int) - ch <- 1 - x, ok := <- ch - ok = true - x = nil - float_var := 1.0e10 - defer fmt.Println('\'') - defer fmt.Println(`exitting now\`) - var fv1 float64 = 0.75 - go println(len("hello world!")) - return - } - -**XML** - - -
Title
- - - -**Lasso** - - 10 - ORDER BY `Name` LIMIT 30'); - Inline: -Username=$DBuser, -Password=$DBpass, -Database=$DBname, -sql=#query; - var("class.name" = (found_count != 0 ? `subtotal` | `nonefound`)); - records; - output: ?>[found_count]
- [noprocess] causes [delimiters] to be skipped until the next [/noprocess]
- {
- local(result = #value->append(#other->asString))
- return #result
- }
- /**! descriptive text */
- define person => type {
- data name::string, protected nickname
- data birthdate::date
- data private ssn = null
- public showName() => return .'name'
- protected fullName() => '"' + .nickname + '"' + .'name'
- public ssnListed => .ssn ? true | false
- }
- define person->name=(value) => {
- .'name' = #value
- return self->'name'
- }
- // query expression
- with n in array(-1, 0xABCD, 3.14159e14)
- let swapped = pair(#n->second, #n->first)
- group #swapped by #n->first into t
- let key = #t->key
- order by #key
- select pair(#key, #t)
- do {^
- #n->upperCase
- ^}
- ?>
-
-**Markdown**
-
- # hello world
-
- you can write text [with links](http://example.com).
-
- * one _thing_ has *em*phasis
- * two __things__ are **bold**
+## Python's profiler output
+
+ 261917242 function calls in 686.251 CPU seconds
+
+ ncalls tottime filename:lineno(function)
+ 152824 513.894 {method 'sort' of 'list' objects}
+ 129590630 83.894 rrule.py:842(__cmp__)
+ 129590630 82.439 {cmp}
+ 153900 1.296 rrule.py:399(_iter)
+ 304393/151570 0.963 rrule.py:102(_iter_cached)
+
+## Ruby
+
+ class A < B; def self.create(object = User) object end end
+ class Zebra; def inspect; "X#{2 + self.object_id}" end end
+
+ module ABC::DEF
+ include Comparable
+
+ # @param test
+ # @return [String] nothing
+ def foo(test)
+ Thread.new do |blockvar|
+ ABC::DEF.reverse(:a_symbol, :'a symbol', :<=>, 'test' + test)
+ end.join
+ end
+
+ def [](index) self[index] end
+ def ==(other) other == self end
+ end
+
+ anIdentifier = an_identifier
+ Constant = 1
+ render action: :new
+
+## Haml
+
+ !!! XML
+ %html
+ %body
+ %h1.jumbo{:id=>"a", :style=>'font-weight: normal', :title=>title} highlight.js
+ /html comment
+ -# ignore this line
+ %ul(style='margin: 0')
+ -items.each do |i|
+ %i= i
+ = variable
+ =variable2
+ ~ variable3
+ ~variable4
+ The current year is #{DataTime.now.year}.
+
+## Perl
+
+ # loads object
+ sub load
+ {
+ my $flds = $c->db_load($id,@_) || do {
+ Carp::carp "Can`t load (class: $c, id: $id): '$!'"; return undef
+ };
+ my $o = $c->_perl_new();
+ $id12 = $id / 24 / 3600;
+ $o->{'ID'} = $id12 + 123;
+ #$o->{'SHCUT'} = $flds->{'SHCUT'};
+ my $p = $o->props;
+ my $vt;
+ $string =~ m/^sought_text$/;
+ $items = split //, 'abc';
+ for my $key (keys %$p)
+ {
+ if(${$vt.'::property'}) {
+ $o->{$key . '_real'} = $flds->{$key};
+ tie $o->{$key}, 'CMSBuilder::Property', $o, $key;
+ }
+ }
+ $o->save if delete $o->{'_save_after_load'};
+ return $o;
+ }
+
+ =head1 NAME
+ POD till the end of file
+
+## PHP
+
+ require_once 'Zend/Uri/Http.php';
+
+ abstract class URI extends BaseURI
+ {
+
+ /**
+ * Returns a URI
+ *
+ * @return URI
+ */
+ static public function _factory($stats = array(), $uri = 'http')
+ {
+ $uri = explode(':', $uri, 0b10);
+ $schemeSpecific = isset($uri[1]) ? $uri[1] : '';
+ $desc = 'Multi
+ line description';
+
+ // Security check
+ if (!ctype_alnum($scheme)) {
+ throw new Zend_Uri_Exception('Illegal scheme');
+ }
+
+ return [
+ 'uri' => $uri,
+ 'value' => null,
+ ];
+ }
+ }
+
+ __halt_compiler () ; datahere
+ datahere
+ datahere */
+ datahere
+
+## Scala
+
+ object abstractTypes extends Application {
+ abstract class SeqBuffer {
+ type T; val element: Seq[T]; def length = element.length
+ }
+ }
+
+ /** Turn command line arguments to uppercase */
+ object Main {
+ def main(args: Array[String]) {
+ val res = for (a <- args) yield a.toUpperCase
+ println("Arguments: " + res.toString)
+ }
+ }
+
+ /** Maps are easy to use in Scala. */
+ object Maps {
+ val colors = Map("red" -> 0xFF0000,
+ "turquoise" -> 0x00FFFF,
+ "black" -> 0x000000,
+ "orange" -> 0xFF8040,
+ "brown" -> 0x804000)
+ def main(args: Array[String]) {
+ for (name <- args) println(
+ colors.get(name) match {
+ case Some(code) =>
+ name + " has code: " + code
+ case None =>
+ "Unknown color: " + name
+ }
+ )
+ }
+ }
+
+## Go
+
+ package main
+
+ import (
+ "fmt"
+ "rand"
+ "os"
+ )
+
+ const (
+ Sunday = iota
+ Partyday
+ numberOfDays // this constant is not exported
+ )
+
+ type Foo interface {
+ FooFunc(int, float32) (complex128, []int)
+ }
+
+ // simple comment
+ type Bar struct {
+ os.File /* multi
+ line
+ comment */
+
+ PublicData chan int
+ }
+
+ func main() {
+ ch := make(chan int)
+ ch <- 1
+ x, ok := <- ch
+ ok = true
+ x = nil
+ float_var := 1.0e10
+ defer fmt.Println('\'')
+ defer fmt.Println(`exitting now\`)
+ var fv1 float64 = 0.75
+ go println(len("hello world!"))
+ return
+ }
+
+## XML
+
+
+ Title
+ + + +## Lasso + + 10 + ORDER BY `Name` LIMIT 30'); + Inline: -Username=$DBuser, -Password=$DBpass, -Database=$DBname, -sql=#query; + var("class.name" = (found_count != 0 ? `subtotal` | `nonefound`)); + records; + output: ?>[found_count]
+ [noprocess] causes [delimiters] to be skipped until the next [/noprocess]
+ {
+ local(result = #value->append(#other->asString))
+ return #result
+ }
+ /**! descriptive text */
+ define person => type {
+ data name::string, protected nickname
+ data birthdate::date
+ data private ssn = null
+ public showName() => return .'name'
+ protected fullName() => '"' + .nickname + '"' + .'name'
+ public ssnListed => .ssn ? true | false
+ }
+ define person->name=(value) => {
+ .'name' = #value
+ return self->'name'
+ }
+ // query expression
+ with n in array(-1, 0xABCD, 3.14159e14)
+ let swapped = pair(#n->second, #n->first)
+ group #swapped by #n->first into t
+ let key = #t->key
+ order by #key
+ select pair(#key, #t)
+ do {^
+ #n->upperCase
+ ^}
+ ?>
+
+## Markdown
+
+ # hello world
+
+ you can write text [with links](http://example.com).
+
+ * one _thing_ has *em*phasis
+ * two __things__ are **bold**
+
+ ---
+
+ hello world
+ ===========
+
+ Hours
- {% endfor %} - {% endif %} +-
+ {{#each content.users}}
+
- {{firstName}} + {{/each}} +
Example
+
;
+ }
+ for (var i = 0 / 2; i < classes.length; i++) { // "0 / 2" should not be parsed as regexp
+ if (checkCondition(classes[i]) === undefined)
+ return /\d+[\s/]/g;
+ }
+ }
+
+## CoffeeScript
+
+ # Divisions
+ x = 6/foo/i
+ x = 6 /foo
+ x = 6 / foo
+ x = 6 /foo * 2/gm
+ x = f /foo
+ x = f / foo / gm
+ x = f /foo * 2/6
+
+ # Regexps
+ x = f /6 * 2/ - 3
+ x = f /foo * 2/gm
+ x = if true then /\n/ else /[.,]+/
+
+ grade = (student, period=(if b? then 7 else 6), messages={"A": "Excellent"}) ->
+ if student.excellentWork
+ "A+"
+ else if student.okayStuff
+ if student.triedHard then "B" else "B-"
+ else
+ "C"
+
+ square = (x) -> x * x
+
+ two = -> 2
+
+ math =
+ root: Math.sqrt
+ square: square
+ cube: (x) -> x * square x
+
+ race = (winner, runners...) ->
+ print winner, runners
+
+ class Animal extends Being
+ constructor: (@name) ->
+
+ move: (meters) ->
+ alert @name + " moved #{meters}m."
+
+ hi = `function() {
+ return [document.title, "Hello JavaScript"].join(": ");
+ }`
+
+ heredoc = """
+ CoffeeScript subst test #{ 010 + 0xf / 0b10 + "nested string #{ /\n/ }"}
+ """
+
+ ###
+ CoffeeScript Compiler v1.2.0
+ Released under the MIT License
+ ###
+
+ OPERATOR = /// ^ (
+ ?: [-=]> # function
+ ) ///
+
+## ActionScript
+
+ package org.example.dummy {
+ import org.dummy.*;
+
+ /*define package inline interface*/
+ public interface IFooBarzable {
+ public function foo(... pairs):Array;
+ }
+
+ public class FooBar implements IFooBarzable {
+ static private var cnt:uint = 0;
+ private var bar:String;
+
+ //constructor
+ public function TestBar(bar:String):void {
+ bar = bar;
+ ++cnt;
+ }
+
+ public function foo(... pairs):Array {
+ pairs.push(bar);
+ return pairs;
+ }
+ }
+ }
+
+## VB.NET
+
+ Import System
+ Import System.IO
+ #Const DEBUG = True
+
+ Namespace Highlighter.Test
+ ''' 1234
Hours
+ WorldBegin --
- {{#each content.users}}
-
- {{firstName}} - {{/each}} -
Example
-
;
- }
- for (var i = 0 / 2; i < classes.length; i++) { // "0 / 2" should not be parsed as regexp
- if (checkCondition(classes[i]) === undefined)
- return /\d+[\s/]/g;
- }
- }
-
-**CoffeeScript**
-
- # Divisions
- x = 6/foo/i
- x = 6 /foo
- x = 6 / foo
- x = 6 /foo * 2/gm
- x = f /foo
- x = f / foo / gm
- x = f /foo * 2/6
-
- # Regexps
- x = f /6 * 2/ - 3
- x = f /foo * 2/gm
- x = if true then /\n/ else /[.,]+/
-
- grade = (student, period=(if b? then 7 else 6), messages={"A": "Excellent"}) ->
- if student.excellentWork
- "A+"
- else if student.okayStuff
- if student.triedHard then "B" else "B-"
- else
- "C"
-
- square = (x) -> x * x
-
- two = -> 2
-
- math =
- root: Math.sqrt
- square: square
- cube: (x) -> x * square x
-
- race = (winner, runners...) ->
- print winner, runners
-
- class Animal extends Being
- constructor: (@name) ->
-
- move: (meters) ->
- alert @name + " moved #{meters}m."
-
- hi = `function() {
- return [document.title, "Hello JavaScript"].join(": ");
- }`
-
- heredoc = """
- CoffeeScript subst test #{ 010 + 0xf / 0b10 + "nested string #{ /\n/ }"}
- """
-
- ###
- CoffeeScript Compiler v1.2.0
- Released under the MIT License
- ###
-
- OPERATOR = /// ^ (
- ?: [-=]> # function
- ) ///
-
-**ActionScript**
-
- package org.example.dummy {
- import org.dummy.*;
-
- /*define package inline interface*/
- public interface IFooBarzable {
- public function foo(... pairs):Array;
- }
-
- public class FooBar implements IFooBarzable {
- static private var cnt:uint = 0;
- private var bar:String;
-
- //constructor
- public function TestBar(bar:String):void {
- bar = bar;
- ++cnt;
- }
-
- public function foo(... pairs):Array {
- pairs.push(bar);
- return pairs;
- }
- }
- }
-
-**VB.NET**
-
- Import System
- Import System.IO
- #Const DEBUG = True
-
- Namespace Highlighter.Test
- ''' 1234
^eval($i+10)
- ^connect[mysql://host/database]{ - $tab[^table::sql{select * from `table` where a='1'}] - $var_Name[some${value}] - } - } - - ^rem{ - Multiline comment with code: $var - ^while(true){ - ^for[i](1;10){ - ^sleep[] - } - } - } - ^taint[^#0A] - - @GET_base[] - ## Comment for code - # Isn't comment - $result[$.hash_item1[one] $.hash_item2[two]] - -**TeX** - - \documentclass{article} - \usepackage[koi8-r]{inputenc} - \hoffset=0pt - \voffset=.3em - \tolerance=400 - \newcommand{\eTiX}{\TeX} - \begin{document} - \section*{Highlight.js} - \begin{table}[c|c] - $\frac 12\, + \, \frac 1{x^3}\text{Hello \! world}$ & \textbf{Goodbye\~ world} \\\eTiX $ \pi=400 $ - \end{table} - Ch\'erie, \c{c}a ne me pla\^\i t pas! % comment \b - G\"otterd\"ammerung~45\%=34. - $$ - \int\limits_{0}^{\pi}\frac{4}{x-7}=3 - $$ - \end{document} - -**Haskell** - - {-# LANGUAGE TypeSynonymInstances #-} - module Network.UDP - ( DataPacket(..) - , openBoundUDPPort - , openListeningUDPPort - , pingUDPPort - , sendUDPPacketTo - , recvUDPPacket - , recvUDPPacketFrom - ) where - - {- this is a {- nested -} comment -} - - import qualified Data.ByteString as Strict (ByteString, concat, singleton) - import qualified Data.ByteString.Lazy as Lazy (ByteString, toChunks, fromChunks) - import Data.ByteString.Char8 (pack, unpack) - import Network.Socket hiding (sendTo, recv, recvFrom) - import Network.Socket.ByteString (sendTo, recv, recvFrom) - - -- Type class for converting StringLike types to and from strict ByteStrings - class DataPacket a where - toStrictBS :: a -> Strict.ByteString - fromStrictBS :: Strict.ByteString -> a - - instance DataPacket Strict.ByteString where - toStrictBS = id - {-# INLINE toStrictBS #-} - fromStrictBS = id - {-# INLINE fromStrictBS #-} - - openBoundUDPPort :: String -> Int -> IO Socket - openBoundUDPPort uri port = do - s <- getUDPSocket - bindAddr <- inet_addr uri - let a = SockAddrInet (toEnum port) bindAddr - bindSocket s a - return s - - pingUDPPort :: Socket -> SockAddr -> IO () - pingUDPPort s a = sendTo s (Strict.singleton 0) a >> return () - -**Erlang** - - -module(ssh_cli). - - -behaviour(ssh_channel). - - -include("ssh.hrl"). - %% backwards compatibility - -export([listen/1, listen/2, listen/3, listen/4, stop/1]). - - %% state - -record(state, { - cm, - channel - }). - - test(Foo)->Foo. - - init([Shell, Exec]) -> - {ok, #state{shell = Shell, exec = Exec}}; - init([Shell]) -> - false = not true, - io:format("Hello, \"~p!~n", [atom_to_list('World')]), - {ok, #state{shell = Shell}}. - - concat([Single]) -> Single; - concat(RList) -> - EpsilonFree = lists:filter( - fun (Element) -> - case Element of - epsilon -> false; - _ -> true - end - end, - RList), - case EpsilonFree of - [Single] -> Single; - Other -> {concat, Other} - end. - - union_dot_union({union, _}=U1, {union, _}=U2) -> - union(lists:flatten( - lists:map( - fun (X1) -> - lists:map( - fun (X2) -> - concat([X1, X2]) - end, - union_to_list(U2) - ) - end, - union_to_list(U1) - ))). - - -**Erlang REPL** - - 1> Str = "abcd". - "abcd" - 2> L = test:length(Str). - 4 - 3> Descriptor = {L, list_to_atom(Str)}. - {4,abcd} - 4> L. - 4 - 5> b(). - Descriptor = {4,abcd} - L = 4 - Str = "abcd" - ok - 6> f(L). - ok - 7> b(). - Descriptor = {4,abcd} - Str = "abcd" - ok - 8> {L, _} = Descriptor. - {4,abcd} - 9> L. - 4 - 10> 2#101. - 5 - 11> 1.85e+3. - 1850 - -**Rust** - - use std; - - import std::io; - export fac, test1; - - 123; // type int - 123u; // type uint - 123_u; // type uint - 0xff00; // type int - 0xff_u8; // type u8 - 0b1111_1111_1001_0000_i32; // type i32 - 123.0; // type float - 0.1; // type float - 3f; // type float - 0.1f32; // type f32 - 12E+99_f64; // type f64 - - /* Factorial */ - fn fac(n: int) -> int { - let s: str = "This is - a multi-line string. - - It ends with an unescaped '\"'."; - let c: char = 'Ф'; - - let result = 1, i = 1; - while i <= n { // No parens around the condition - result *= i; - i += 1; - } - ret result; - } - - pure fn pure_length^eval($i+10)
+ ^connect[mysql://host/database]{ + $tab[^table::sql{select * from `table` where a='1'}] + $var_Name[some${value}] + } + } + + ^rem{ + Multiline comment with code: $var + ^while(true){ + ^for[i](1;10){ + ^sleep[] + } + } + } + ^taint[^#0A] + + @GET_base[] + ## Comment for code + # Isn't comment + $result[$.hash_item1[one] $.hash_item2[two]] + +## TeX + + \documentclass{article} + \usepackage[koi8-r]{inputenc} + \hoffset=0pt + \voffset=.3em + \tolerance=400 + \newcommand{\eTiX}{\TeX} + \begin{document} + \section*{Highlight.js} + \begin{table}[c|c] + $\frac 12\, + \, \frac 1{x^3}\text{Hello \! world}$ & \textbf{Goodbye\~ world} \\\eTiX $ \pi=400 $ + \end{table} + Ch\'erie, \c{c}a ne me pla\^\i t pas! % comment \b + G\"otterd\"ammerung~45\%=34. + $$ + \int\limits_{0}^{\pi}\frac{4}{x-7}=3 + $$ + \end{document} + +## Haskell + + {-# LANGUAGE TypeSynonymInstances #-} + module Network.UDP + ( DataPacket(..) + , openBoundUDPPort + , openListeningUDPPort + , pingUDPPort + , sendUDPPacketTo + , recvUDPPacket + , recvUDPPacketFrom + ) where + + {- this is a {- nested -} comment -} + + import qualified Data.ByteString as Strict (ByteString, concat, singleton) + import qualified Data.ByteString.Lazy as Lazy (ByteString, toChunks, fromChunks) + import Data.ByteString.Char8 (pack, unpack) + import Network.Socket hiding (sendTo, recv, recvFrom) + import Network.Socket.ByteString (sendTo, recv, recvFrom) + + -- Type class for converting StringLike types to and from strict ByteStrings + class DataPacket a where + toStrictBS :: a -> Strict.ByteString + fromStrictBS :: Strict.ByteString -> a + + instance DataPacket Strict.ByteString where + toStrictBS = id + {-# INLINE toStrictBS #-} + fromStrictBS = id + {-# INLINE fromStrictBS #-} + + openBoundUDPPort :: String -> Int -> IO Socket + openBoundUDPPort uri port = do + s <- getUDPSocket + bindAddr <- inet_addr uri + let a = SockAddrInet (toEnum port) bindAddr + bindSocket s a + return s + + pingUDPPort :: Socket -> SockAddr -> IO () + pingUDPPort s a = sendTo s (Strict.singleton 0) a >> return () + +## Erlang + + -module(ssh_cli). + + -behaviour(ssh_channel). + + -include("ssh.hrl"). + %% backwards compatibility + -export([listen/1, listen/2, listen/3, listen/4, stop/1]). + + %% state + -record(state, { + cm, + channel + }). + + test(Foo)->Foo. + + init([Shell, Exec]) -> + {ok, #state{shell = Shell, exec = Exec}}; + init([Shell]) -> + false = not true, + io:format("Hello, \"~p!~n", [atom_to_list('World')]), + {ok, #state{shell = Shell}}. + + concat([Single]) -> Single; + concat(RList) -> + EpsilonFree = lists:filter( + fun (Element) -> + case Element of + epsilon -> false; + _ -> true + end + end, + RList), + case EpsilonFree of + [Single] -> Single; + Other -> {concat, Other} + end. + + union_dot_union({union, _}=U1, {union, _}=U2) -> + union(lists:flatten( + lists:map( + fun (X1) -> + lists:map( + fun (X2) -> + concat([X1, X2]) + end, + union_to_list(U2) + ) + end, + union_to_list(U1) + ))). + +## Erlang REPL + + 1> Str = "abcd". + "abcd" + 2> L = test:length(Str). + 4 + 3> Descriptor = {L, list_to_atom(Str)}. + {4,abcd} + 4> L. + 4 + 5> b(). + Descriptor = {4,abcd} + L = 4 + Str = "abcd" + ok + 6> f(L). + ok + 7> b(). + Descriptor = {4,abcd} + Str = "abcd" + ok + 8> {L, _} = Descriptor. + {4,abcd} + 9> L. + 4 + 10> 2#101. + 5 + 11> 1.85e+3. + 1850 + +## Rust + + use std; + + import std::io; + export fac, test1; + + 123; // type int + 123u; // type uint + 123_u; // type uint + 0xff00; // type int + 0xff_u8; // type u8 + 0b1111_1111_1001_0000_i32; // type i32 + 123.0; // type float + 0.1; // type float + 3f; // type float + 0.1f32; // type f32 + 12E+99_f64; // type f64 + + /* Factorial */ + fn fac(n: int) -> int { + let s: str = "This is + a multi-line string. + + It ends with an unescaped '\"'."; + let c: char = 'Ф'; + + let result = 1, i = 1; + while i <= n { // No parens around the condition + result *= i; + i += 1; + } + ret result; + } + + pure fn pure_length
#### For Developers
-* [Auto Syntax Highlighting](01_Features/Auto_Syntax_Highlight.md)
-* [Extend Daux.io with Processors](01_For_Developers/Creating_a_Processor.md)
-* Full access to the internal API to create new pages programatically
-* Work with pages metadata
+- [Auto Syntax Highlighting](01_Features/Auto_Syntax_Highlight.md)
+- [Extend Daux.io with Processors](01_For_Developers/Creating_a_Processor.md)
+- Full access to the internal API to create new pages programatically
+- Work with pages metadata
#### For Marketing
-* 100% Mobile Responsive
-* 4 Built-In Themes or roll your own
-* Functional, Flat Design Style
-* Optional code float layout
-* Shareable/Linkable SEO Friendly URLs
-* Supports Google Analytics and Piwik Analytics
+- 100% Mobile Responsive
+- 4 Built-In Themes or roll your own
+- Functional, Flat Design Style
+- Optional code float layout
+- Shareable/Linkable SEO Friendly URLs
+- Supports Google Analytics and Piwik Analytics
@@ -52,7 +52,7 @@
### Installation and usage
-If you have __PHP__ and Composer installed
+If you have **PHP** and Composer installed
```bash
composer global require daux/daux.io
@@ -61,7 +61,7 @@ composer global require daux/daux.io
daux generate
```
-Or if you wish to use __Docker__
+Or if you wish to use **Docker**
```bash
# Next to your `docs` folder, run
@@ -69,18 +69,3 @@ docker run --rm -it -w /build -v "$PWD":/build daux/daux.io daux generate
```
---
-
-
-
-
-
-" .
+ return ' ';
diff --git a/libs/Format/HTMLFile/ContentPage.php b/libs/Format/HTMLFile/ContentPage.php
index e9825f6..277579a 100644
--- a/libs/Format/HTMLFile/ContentPage.php
+++ b/libs/Format/HTMLFile/ContentPage.php
@@ -11,23 +11,23 @@ class ContentPage extends \Todaymade\Daux\Format\Base\ContentPage
{
$content = parent::generatePage();
- //Embed images
+ // Embed images
// We do it after generation so we can catch the images that were in html already
- $content = (new EmbedImages($this->params['tree']))
+ return (new EmbedImages($this->config->getTree()))
->embed(
$content,
$this->file,
- function($src, array $attributes, Raw $file) {
- $content = base64_encode(file_get_contents($file->getPath()));
+ function ($src, array $attributes, Raw $file) {
+ // TODO :: ignore absolute paths
+ $content = base64_encode(file_get_contents($file->getPath()));
$attr = '';
foreach ($attributes as $name => $value) {
$attr .= ' ' . $name . '="' . htmlentities($value, ENT_QUOTES, 'UTF-8', false) . '"';
}
+ // TODO :: handle other formats than PNG as well
return "![](\"data:image/png;base64,$content\"/)
";
}
);
-
- return $content;
}
}
diff --git a/libs/Format/HTMLFile/ContentTypes/Markdown/CommonMarkConverter.php b/libs/Format/HTMLFile/ContentTypes/Markdown/CommonMarkConverter.php
index cf97727..b362310 100644
--- a/libs/Format/HTMLFile/ContentTypes/Markdown/CommonMarkConverter.php
+++ b/libs/Format/HTMLFile/ContentTypes/Markdown/CommonMarkConverter.php
@@ -1,13 +1,11 @@
getConfig('daux'));
}
}
diff --git a/libs/Format/HTMLFile/ContentTypes/Markdown/ContentType.php b/libs/Format/HTMLFile/ContentTypes/Markdown/ContentType.php
index 00e2157..e66eb03 100644
--- a/libs/Format/HTMLFile/ContentTypes/Markdown/ContentType.php
+++ b/libs/Format/HTMLFile/ContentTypes/Markdown/ContentType.php
@@ -1,12 +1,9 @@
config = $config;
- $this->converter = new CommonMarkConverter(['daux' => $config]);
+ return new CommonMarkConverter(['daux' => $this->config]);
}
}
diff --git a/libs/Format/HTMLFile/ContentTypes/Markdown/LinkRenderer.php b/libs/Format/HTMLFile/ContentTypes/Markdown/LinkRenderer.php
index f4ccc67..e552ca8 100644
--- a/libs/Format/HTMLFile/ContentTypes/Markdown/LinkRenderer.php
+++ b/libs/Format/HTMLFile/ContentTypes/Markdown/LinkRenderer.php
@@ -4,30 +4,22 @@ use League\CommonMark\ElementRendererInterface;
use League\CommonMark\HtmlElement;
use League\CommonMark\Inline\Element\AbstractInline;
use League\CommonMark\Inline\Element\Link;
-use Todaymade\Daux\Config;
use Todaymade\Daux\DauxHelper;
use Todaymade\Daux\Exception\LinkNotFoundException;
-use Todaymade\Daux\Tree\Entry;
class LinkRenderer extends \Todaymade\Daux\ContentTypes\Markdown\LinkRenderer
{
/**
* @param AbstractInline|Link $inline
- * @param ElementRendererInterface $htmlRenderer
- * @return HtmlElement
+ *
* @throws LinkNotFoundException
+ *
+ * @return HtmlElement
*/
public function render(AbstractInline $inline, ElementRendererInterface $htmlRenderer)
{
- // This can't be in the method type as
- // the method is an abstract and should
- // have the same interface
- if (!$inline instanceof Link) {
- throw new \RuntimeException(
- 'Wrong type passed to ' . __CLASS__ . '::' . __METHOD__ .
- " the expected type was 'League\\CommonMark\\Inline\\Element\\Link' but '" .
- get_class($inline) . "' was provided"
- );
+ if (!($inline instanceof Link)) {
+ throw new \InvalidArgumentException('Incompatible inline type: ' . \get_class($inline));
}
$element = parent::render($inline, $htmlRenderer);
@@ -36,12 +28,12 @@ class LinkRenderer extends \Todaymade\Daux\ContentTypes\Markdown\LinkRenderer
// empty urls and anchors should
// not go through the url resolver
- if (!$this->isValidUrl($url)) {
+ if (!DauxHelper::isValidUrl($url)) {
return $element;
}
// Absolute urls, shouldn't either
- if ($this->isExternalUrl($url)) {
+ if (DauxHelper::isExternalUrl($url)) {
$element->setAttribute('class', 'Link--external');
return $element;
@@ -51,12 +43,12 @@ class LinkRenderer extends \Todaymade\Daux\ContentTypes\Markdown\LinkRenderer
$urlAndHash = explode('#', $url);
if (isset($urlAndHash[1])) {
$element->setAttribute('href', '#' . $urlAndHash[1]);
-
+
return $element;
}
try {
- $file = $this->resolveInternalFile($url);
+ $file = DauxHelper::resolveInternalFile($this->daux, $url);
$url = $file->getUrl();
} catch (LinkNotFoundException $e) {
if ($this->daux->isStatic()) {
@@ -71,4 +63,4 @@ class LinkRenderer extends \Todaymade\Daux\ContentTypes\Markdown\LinkRenderer
return $element;
}
-}
\ No newline at end of file
+}
diff --git a/libs/Format/HTMLFile/Generator.php b/libs/Format/HTMLFile/Generator.php
index 4d4f27b..14bfaf0 100644
--- a/libs/Format/HTMLFile/Generator.php
+++ b/libs/Format/HTMLFile/Generator.php
@@ -4,27 +4,28 @@ use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Todaymade\Daux\Console\RunAction;
use Todaymade\Daux\Daux;
-use Todaymade\Daux\Format\HTML\Template;
use Todaymade\Daux\Format\HTML\HTMLUtils;
+use Todaymade\Daux\Format\HTML\Template;
use Todaymade\Daux\Format\HTMLFile\ContentTypes\Markdown\ContentType;
class Generator implements \Todaymade\Daux\Format\Base\Generator
{
- use RunAction, HTMLUtils;
+ use RunAction;
+ use HTMLUtils;
/** @var Daux */
protected $daux;
- /**
- * @param Daux $daux
- */
+ /** @var Template */
+ protected $templateRenderer;
+
public function __construct(Daux $daux)
{
- $params = $daux->getParams();
+ $config = $daux->getConfig();
$this->daux = $daux;
- $this->templateRenderer = new Template($params);
- $params->templateRenderer = $this->templateRenderer;
+ $this->templateRenderer = new Template($config);
+ $config->templateRenderer = $this->templateRenderer;
}
/**
@@ -33,7 +34,7 @@ class Generator implements \Todaymade\Daux\Format\Base\Generator
public function getContentTypes()
{
return [
- 'markdown' => new ContentType($this->daux->getParams()),
+ 'markdown' => new ContentType($this->daux->getConfig()),
];
}
@@ -44,23 +45,23 @@ class Generator implements \Todaymade\Daux\Format\Base\Generator
{
$destination = $input->getOption('destination');
- $params = $this->daux->getParams();
+ $config = $this->daux->getConfig();
if (is_null($destination)) {
- $destination = $this->daux->local_base . DIRECTORY_SEPARATOR . 'static';
+ $destination = $config->getLocalBase() . DIRECTORY_SEPARATOR . 'static';
}
$this->runAction(
'Cleaning destination folder ...',
$width,
- function() use ($destination, $params) {
+ function () use ($destination) {
$this->ensureEmptyDestination($destination);
}
);
$data = [
- 'author' => $params['author'],
- 'title' => $params['title'],
- 'subject' => $params['tagline']
+ 'author' => $config->getAuthor(),
+ 'title' => $config->getTitle(),
+ 'subject' => $config->getTagline(),
];
$book = new Book($this->daux->tree, $data);
@@ -70,9 +71,9 @@ class Generator implements \Todaymade\Daux\Format\Base\Generator
$this->runAction(
'Generating ' . $current->getTitle(),
$width,
- function () use ($book, $current, $params) {
+ function () use ($book, $current, $config) {
$contentType = $this->daux->getContentTypeHandler()->getType($current);
- $content = ContentPage::fromFile($current, $params, $contentType);
+ $content = ContentPage::fromFile($current, $config, $contentType);
$content->templateRenderer = $this->templateRenderer;
$content = $content->getContent();
$book->addPage($current, $content);
diff --git a/libs/FormatDate.php b/libs/FormatDate.php
index 464e812..b853c78 100644
--- a/libs/FormatDate.php
+++ b/libs/FormatDate.php
@@ -4,13 +4,14 @@ use IntlDateFormatter;
class FormatDate
{
- public static function format($params, $date) {
- $locale = $params['language'];
+ public static function format($config, $date)
+ {
+ $locale = $config->getLanguage();
$datetype = IntlDateFormatter::LONG;
$timetype = IntlDateFormatter::SHORT;
$timezone = null;
- if (!extension_loaded("intl")) {
+ if (!extension_loaded('intl')) {
$locale = 'en';
$timezone = 'GMT';
}
@@ -19,4 +20,4 @@ class FormatDate
return $formatter->format($date);
}
-}
\ No newline at end of file
+}
diff --git a/libs/GeneratorHelper.php b/libs/GeneratorHelper.php
index 4e87580..6219109 100755
--- a/libs/GeneratorHelper.php
+++ b/libs/GeneratorHelper.php
@@ -5,7 +5,7 @@ use RuntimeException;
class GeneratorHelper
{
/**
- * Remove a directory recursively
+ * Remove a directory recursively.
*
* @param string $dir
*/
@@ -26,7 +26,7 @@ class GeneratorHelper
}
/**
- * Copy files recursively
+ * Copy files recursively.
*
* @param string $source
* @param string $destination
@@ -39,7 +39,7 @@ class GeneratorHelper
$dir = opendir($source);
- if (!$dir) {
+ if ($dir === false) {
throw new RuntimeException("Cannot copy '$source' to '$destination'");
}
diff --git a/libs/Processor.php b/libs/Processor.php
index 122a732..96d006e 100644
--- a/libs/Processor.php
+++ b/libs/Processor.php
@@ -22,8 +22,6 @@ class Processor
protected $width;
/**
- * @param Daux $daux
- * @param OutputInterface $output
* @param int $width
*/
public function __construct(Daux $daux, OutputInterface $output, $width)
@@ -37,10 +35,8 @@ class Processor
* With this connection point, you can transform
* the tree as you want, move pages, modify
* pages and even add new ones.
- *
- * @param Root $root
*/
- public function manipulateTree(/** @scrutinizer ignore-unused */ Root $root)
+ public function manipulateTree(/* @scrutinizer ignore-unused */ Root $root)
{
}
@@ -48,10 +44,8 @@ class Processor
* This connection point provides
* a way to extend the Markdown
* parser and renderer.
- *
- * @param Environment $environment
*/
- public function extendCommonMarkEnvironment(/** @scrutinizer ignore-unused */ Environment $environment)
+ public function extendCommonMarkEnvironment(/* @scrutinizer ignore-unused */ Environment $environment)
{
}
diff --git a/libs/Server/ErrorPage.php b/libs/Server/ErrorPage.php
index f9084d3..c6c81dd 100644
--- a/libs/Server/ErrorPage.php
+++ b/libs/Server/ErrorPage.php
@@ -12,17 +12,17 @@ class ErrorPage extends SimplePage
/**
* @var \Todaymade\Daux\Config
*/
- private $params;
+ private $config;
/**
* @param string $title
* @param string $content
- * @param \Todaymade\Daux\Config $params
+ * @param \Todaymade\Daux\Config $config
*/
- public function __construct($title, $content, $params)
+ public function __construct($title, $content, $config)
{
parent::__construct($title, $content);
- $this->params = $params;
+ $this->config = $config;
}
/**
@@ -30,15 +30,15 @@ class ErrorPage extends SimplePage
*/
protected function generatePage()
{
- $params = $this->params;
+ $config = $this->config;
$page = [
'title' => $this->title,
'content' => $this->getPureContent(),
'language' => '',
];
- $template = new Template($params);
+ $template = new Template($config);
- return $template->render('error', ['page' => $page, 'params' => $params]);
+ return $template->render('error', ['page' => $page, 'config' => $config]);
}
}
diff --git a/libs/Server/ExtensionMimeTypeGuesser.php b/libs/Server/ExtensionMimeTypeGuesser.php
index 1dff5d8..e1de672 100644
--- a/libs/Server/ExtensionMimeTypeGuesser.php
+++ b/libs/Server/ExtensionMimeTypeGuesser.php
@@ -1,29 +1,12 @@
guess($path);
+ $extension = pathinfo($path, PATHINFO_EXTENSION);
+
+ if ($extension == 'css') {
+ return 'text/css';
+ }
+
+ if ($extension == 'js') {
+ return 'application/javascript';
+ }
+
+ return null;
}
}
diff --git a/libs/Server/Server.php b/libs/Server/Server.php
index 6f3c726..f6af68a 100755
--- a/libs/Server/Server.php
+++ b/libs/Server/Server.php
@@ -1,10 +1,11 @@
daux = $daux;
+
+ $this->request = Request::createFromGlobals();
+ $this->base_url = $this->request->getHttpHost() . $this->request->getBaseUrl() . '/';
+ }
+
/**
- * Serve the documentation
+ * Serve the documentation.
*
* @throws Exception
*/
public static function serve()
{
- $output = new NullOutput();
+ $verbosity = getenv('DAUX_VERBOSITY');
+ $output = new ConsoleOutput($verbosity);
- $daux = new Daux(Daux::LIVE_MODE, $output);
- $daux->initializeConfiguration();
+ $configFile = getenv('DAUX_CONFIG');
+ if ($configFile) {
+ $config = ConfigBuilder::fromFile($configFile);
+ } else {
+ $config = ConfigBuilder::withMode(Daux::LIVE_MODE)->build();
+ }
+
+ $daux = new Daux($config, $output);
$class = $daux->getProcessorClass();
if (!empty($class)) {
$daux->setProcessor(new $class($daux, $output, 0));
}
- // Set this critical configuration
- // for the tree generation
- $daux->getParams()['index_key'] = 'index';
-
// Improve the tree with a processor
$daux->generateTree();
@@ -53,30 +65,24 @@ class Server
try {
$page = $server->handle();
} catch (NotFoundException $e) {
- $page = new ErrorPage('An error occured', $e->getMessage(), $daux->getParams());
+ $page = new ErrorPage('An error occured', $e->getMessage(), $daux->getConfig());
}
$server->createResponse($page)->prepare($server->request)->send();
}
- public function __construct(Daux $daux)
- {
- $this->daux = $daux;
-
- $this->request = Request::createFromGlobals();
- $this->base_url = $this->request->getHttpHost() . $this->request->getBaseUrl() . "/";
- }
-
/**
* Create a temporary file with the file suffix, for mime type detection.
*
* @param string $postfix
+ *
* @return string
*/
- private function getTemporaryFile($postfix) {
+ private function getTemporaryFile($postfix)
+ {
$sysFileName = tempnam(sys_get_temp_dir(), 'daux');
if ($sysFileName === false) {
- throw new \RuntimeException("Could not create temporary file");
+ throw new \RuntimeException('Could not create temporary file');
}
$newFileName = $sysFileName . $postfix;
@@ -88,15 +94,16 @@ class Server
return $newFileName;
}
- throw new \RuntimeException("Could not create temporary file");
+ throw new \RuntimeException('Could not create temporary file');
}
/**
- * @param Page $page
* @return Response
*/
- public function createResponse(Page $page) {
-
+ public function createResponse(Page $page)
+ {
+ // Add a custom MimeType guesser in case the default ones are not available
+ // This makes sure that at least CSS and JS work fine.
$mimeTypes = MimeTypes::getDefault();
$mimeTypes->registerGuesser(new ExtensionMimeTypeGuesser());
@@ -107,6 +114,7 @@ class Server
if ($page instanceof ComputedRawPage) {
$file = $this->getTemporaryFile($page->getFilename());
file_put_contents($file, $page->getContent());
+
return new BinaryFileResponse($file);
}
@@ -116,32 +124,26 @@ class Server
/**
* @return \Todaymade\Daux\Config
*/
- public function getParams()
+ public function getConfig()
{
- $params = $this->daux->getParams();
+ $config = $this->daux->getConfig();
- DauxHelper::rebaseConfiguration($params, '//' . $this->base_url);
- $params['base_page'] = '//' . $this->base_url;
- if (!$this->daux->options['live']['clean_urls']) {
- $params['base_page'] .= 'index.php/';
- }
+ DauxHelper::rebaseConfiguration($config, '//' . $this->base_url);
- // Text search would be too slow on live server
- $params['html']['search'] = false;
-
- return $params;
+ return $config;
}
/**
- * Handle an incoming request
+ * Handle an incoming request.
*
- * @return \Todaymade\Daux\Format\Base\Page
* @throws Exception
* @throws NotFoundException
+ *
+ * @return \Todaymade\Daux\Format\Base\Page
*/
public function handle()
{
- $this->params = $this->getParams();
+ $this->config = $this->getConfig();
$request = substr($this->request->getRequestUri(), strlen($this->request->getBaseUrl()) + 1);
@@ -157,27 +159,31 @@ class Server
}
/**
- * Handle a request on custom themes
+ * Handle a request on custom themes.
*
* @param string $request
- * @return \Todaymade\Daux\Format\Base\Page
+ *
* @throws NotFoundException
+ *
+ * @return \Todaymade\Daux\Format\Base\Page
*/
public function serveTheme($request)
{
- $file = $this->getParams()->getThemesPath() . $request;
+ $file = $this->getConfig()->getThemesPath() . $request;
if (file_exists($file)) {
return new RawPage($file);
}
- throw new NotFoundException;
+ throw new NotFoundException();
}
/**
* @param string $request
- * @return \Todaymade\Daux\Format\Base\Page
+ *
* @throws NotFoundException
+ *
+ * @return \Todaymade\Daux\Format\Base\Page
*/
private function getPage($request)
{
@@ -197,6 +203,6 @@ class Server
);
}
- return $this->daux->getGenerator()->generateOne($file, $this->params);
+ return $this->daux->getGenerator()->generateOne($file, $this->config);
}
}
diff --git a/libs/Tree/Builder.php b/libs/Tree/Builder.php
index 82772fd..487122c 100644
--- a/libs/Tree/Builder.php
+++ b/libs/Tree/Builder.php
@@ -14,7 +14,7 @@ class Builder
'.DS_Store', 'Thumbs.db',
];
- protected static function isIgnored(\SplFileInfo $file, $ignore)
+ protected static function isIgnored(SplFileInfo $file, $ignore)
{
$filename = $file->getFilename();
@@ -34,9 +34,10 @@ class Builder
}
/**
- * Get name for a file
+ * Get name for a file.
*
* @param string $path
+ *
* @return string
*/
protected static function getName($path)
@@ -52,14 +53,16 @@ class Builder
}
/**
- * Build the initial tree
+ * Build the initial tree.
*
* @param Directory $node
* @param array $ignore
*/
public static function build($node, $ignore)
{
- if (($it = new \FilesystemIterator($node->getPath())) == false) {
+ try {
+ $it = new \FilesystemIterator($node->getPath());
+ } catch (\UnexpectedValueException $e) {
return;
}
@@ -94,8 +97,6 @@ class Builder
}
/**
- * @param Directory $parent
- * @param SplFileInfo $file
* @return Content|Raw
*/
public static function createContent(Directory $parent, SplFileInfo $file)
@@ -104,7 +105,7 @@ class Builder
$config = $parent->getConfig();
- if (!in_array($file->getExtension(), $config['valid_content_extensions'])) {
+ if (!in_array($file->getExtension(), $config->getValidContentExtensions())) {
$uri = $file->getFilename();
$entry = new Raw($parent, $uri, $file);
@@ -122,7 +123,7 @@ class Builder
$entry = new Content($parent, $uri, $file);
- if ($entry->getUri() == $config['index_key']) {
+ if ($entry->getUri() == $config->getIndexKey()) {
if ($parent instanceof Root) {
$entry->setTitle($config->getTitle());
} else {
@@ -139,6 +140,7 @@ class Builder
/**
* @param string $filename
+ *
* @return string
*/
public static function removeSortingInformations($filename)
@@ -152,8 +154,8 @@ class Builder
}
/**
- * @param Directory $parent
* @param string $title
+ *
* @return Directory
*/
public static function getOrCreateDir(Directory $parent, $title)
@@ -171,8 +173,8 @@ class Builder
}
/**
- * @param Directory $parent
* @param string $path
+ *
* @return ContentAbstract
*/
public static function getOrCreatePage(Directory $parent, $path)
@@ -184,7 +186,7 @@ class Builder
$path .= '.md';
}
- $raw = !in_array($extension, $parent->getConfig()['valid_content_extensions']);
+ $raw = !in_array($extension, $parent->getConfig()->getValidContentExtensions());
$title = $uri = $path;
if (!$raw) {
@@ -212,11 +214,10 @@ class Builder
}
/**
- * Sort the tree recursively
- *
- * @param Directory $current
+ * Sort the tree recursively.
*/
- public static function sortTree(Directory $current) {
+ public static function sortTree(Directory $current)
+ {
$current->sort();
foreach ($current->getEntries() as $entry) {
if ($entry instanceof Directory) {
@@ -226,10 +227,10 @@ class Builder
}
/**
- * Calculate next and previous for all pages
+ * Calculate next and previous for all pages.
*
- * @param Directory $current
* @param null|Content $prev
+ *
* @return null|Content
*/
public static function finalizeTree(Directory $current, $prev = null)
@@ -249,5 +250,4 @@ class Builder
return $prev;
}
-
}
diff --git a/libs/Tree/Content.php b/libs/Tree/Content.php
index 7259e16..762bc76 100644
--- a/libs/Tree/Content.php
+++ b/libs/Tree/Content.php
@@ -24,8 +24,8 @@ class Content extends ContentAbstract
{
if ($this->manuallySetContent) {
$content = $this->content;
- } else if (!$this->getPath()) {
- throw new RuntimeException("Empty content");
+ } elseif (!$this->getPath()) {
+ throw new RuntimeException('Empty content');
} else {
$content = file_get_contents($this->getPath());
}
@@ -40,10 +40,7 @@ class Content extends ContentAbstract
return $frontMatter->parse($content);
}
- /**
- * @return string
- */
- public function getContent()
+ public function getContent(): string
{
if ($this->attributes === null) {
$this->parseAttributes();
@@ -52,10 +49,7 @@ class Content extends ContentAbstract
return $this->content;
}
- /**
- * @param string $content
- */
- public function setContent($content)
+ public function setContent(string $content): void
{
$this->manuallySetContent = true;
$this->content = $content;
@@ -64,15 +58,12 @@ class Content extends ContentAbstract
/**
* @return Content
*/
- public function getPrevious()
+ public function getPrevious(): ?Content
{
return $this->previous;
}
- /**
- * @param Content $previous
- */
- public function setPrevious($previous)
+ public function setPrevious(Content $previous)
{
$this->previous = $previous;
}
@@ -80,15 +71,12 @@ class Content extends ContentAbstract
/**
* @return Content
*/
- public function getNext()
+ public function getNext(): ?Content
{
return $this->next;
}
- /**
- * @param Content $next
- */
- public function setNext($next)
+ public function setNext(Content $next)
{
$this->next = $next;
}
@@ -102,7 +90,7 @@ class Content extends ContentAbstract
return $this->name == 'index' || $this->name == '_index';
}
- public function getTitle()
+ public function getTitle(): string
{
if ($title = $this->getAttribute('title')) {
return $title;
@@ -130,10 +118,11 @@ class Content extends ContentAbstract
}
/**
- * Get one or all attributes for the content
+ * Get one or all attributes for the content.
*
- * @param string|null $key
- * @return array|mixed|null
+ * @param null|string $key
+ *
+ * @return null|array|mixed
*/
public function getAttribute($key = null)
{
diff --git a/libs/Tree/ContentAbstract.php b/libs/Tree/ContentAbstract.php
index 6636645..8c0590e 100644
--- a/libs/Tree/ContentAbstract.php
+++ b/libs/Tree/ContentAbstract.php
@@ -5,18 +5,12 @@ abstract class ContentAbstract extends Entry
/** @var string */
protected $content;
- /**
- * @return string
- */
- public function getContent()
+ public function getContent(): string
{
return $this->content;
}
- /**
- * @param string $content
- */
- public function setContent($content)
+ public function setContent(string $content): void
{
$this->content = $content;
}
diff --git a/libs/Tree/Directory.php b/libs/Tree/Directory.php
index 958f1d6..aa10117 100644
--- a/libs/Tree/Directory.php
+++ b/libs/Tree/Directory.php
@@ -2,6 +2,7 @@
use ArrayIterator;
use RuntimeException;
+use Todaymade\Daux\Config;
class Directory extends Entry implements \ArrayAccess, \IteratorAggregate
{
@@ -25,14 +26,25 @@ class Directory extends Entry implements \ArrayAccess, \IteratorAggregate
];
foreach ($this->children as $key => $entry) {
+ // In case of generated pages, the name might be empty.
+ // Thus we are falling back to other solutions, otherwise the page would disappear from the tree.
$name = $entry->getName();
- if ($name == 'index' || $name == '_index') {
- $buckets['index'][$key] = $entry;
- continue;
+ if (!$name) {
+ $name = $entry->getTitle();
}
if (!$name) {
+ $name = $key;
+ }
+
+ if (!$name) {
+ continue;
+ }
+
+ if ($name == 'index' || $name == '_index') {
+ $buckets['index'][$key] = $entry;
+
continue;
}
@@ -40,10 +52,12 @@ class Directory extends Entry implements \ArrayAccess, \IteratorAggregate
if (is_numeric($name[1])) {
$exploded = explode('_', $name);
$buckets['down_numeric'][abs(substr($exploded[0], 1))][$key] = $entry;
+
continue;
}
$buckets['down'][$key] = $entry;
+
continue;
}
@@ -51,16 +65,19 @@ class Directory extends Entry implements \ArrayAccess, \IteratorAggregate
if (is_numeric($name[1])) {
$exploded = explode('_', $name);
$buckets['up_numeric'][abs(substr($exploded[0], 1))][$key] = $entry;
+
continue;
}
$buckets['up'][$key] = $entry;
+
continue;
}
if (is_numeric($name[0])) {
$exploded = explode('_', $name);
$buckets['numeric'][abs($exploded[0])][$key] = $entry;
+
continue;
}
@@ -84,7 +101,7 @@ class Directory extends Entry implements \ArrayAccess, \IteratorAggregate
private function sortBucket($bucket, $final)
{
- uasort($bucket, function(Entry $a, Entry $b) {
+ uasort($bucket, function (Entry $a, Entry $b) {
return strcasecmp($a->getName(), $b->getName());
});
@@ -103,20 +120,17 @@ class Directory extends Entry implements \ArrayAccess, \IteratorAggregate
return $this->children;
}
- public function addChild(Entry $entry)
+ public function addChild(Entry $entry): void
{
$this->children[$entry->getUri()] = $entry;
}
- public function removeChild(Entry $entry)
+ public function removeChild(Entry $entry): void
{
unset($this->children[$entry->getUri()]);
}
- /**
- * @return \Todaymade\Daux\Config
- */
- public function getConfig()
+ public function getConfig(): Config
{
if (!$this->parent) {
throw new \RuntimeException('Could not retrieve configuration. Are you sure that your tree has a Root ?');
@@ -125,8 +139,9 @@ class Directory extends Entry implements \ArrayAccess, \IteratorAggregate
return $this->parent->getConfig();
}
- public function getLocalIndexPage() {
- $index_key = $this->getConfig()['index_key'];
+ public function getLocalIndexPage()
+ {
+ $index_key = $this->getConfig()->getIndexKey();
if (isset($this->children[$index_key])) {
return $this->children[$index_key];
@@ -135,15 +150,12 @@ class Directory extends Entry implements \ArrayAccess, \IteratorAggregate
return false;
}
- /**
- * @return Content|null
- */
- public function getIndexPage()
+ public function getIndexPage(): ?Content
{
- $index_key = $this->getConfig()['index_key'];
+ $indexPage = $this->getLocalIndexPage();
- if ($this->getLocalIndexPage()) {
- return $this->getLocalIndexPage();
+ if ($indexPage instanceof Content) {
+ return $indexPage;
}
if ($this->getConfig()->shouldInheritIndex() && $first_page = $this->seekFirstPage()) {
@@ -154,14 +166,13 @@ class Directory extends Entry implements \ArrayAccess, \IteratorAggregate
}
/**
- * Seek the first available page from descendants
- * @return Content|null
+ * Seek the first available page from descendants.
*/
- public function seekFirstPage()
+ public function seekFirstPage(): ?Content
{
if ($this instanceof self) {
- $index_key = $this->getConfig()['index_key'];
- if (isset($this->children[$index_key])) {
+ $index_key = $this->getConfig()->getIndexKey();
+ if (isset($this->children[$index_key]) && $this->children[$index_key] instanceof Content) {
return $this->children[$index_key];
}
foreach ($this->children as $node_key => $node) {
@@ -179,10 +190,7 @@ class Directory extends Entry implements \ArrayAccess, \IteratorAggregate
return null;
}
- /**
- * @return Content|null
- */
- public function getFirstPage()
+ public function getFirstPage(): ?Content
{
if ($this->first_page) {
return $this->first_page;
@@ -214,26 +222,22 @@ class Directory extends Entry implements \ArrayAccess, \IteratorAggregate
return null;
}
- /**
- * @param Content $first_page
- */
- public function setFirstPage($first_page)
+ public function setFirstPage(Content $first_page)
{
$this->first_page = $first_page;
}
/**
* Used when creating the navigation.
- * Hides folders without showable content
- *
- * @return bool
+ * Hides folders without showable content.
*/
- public function hasContent()
+ public function hasContent(): bool
{
foreach ($this->getEntries() as $node) {
if ($node instanceof Content) {
return true;
- } elseif ($node instanceof self) {
+ }
+ if ($node instanceof self) {
if ($node->hasContent()) {
return true;
}
@@ -258,19 +262,23 @@ class Directory extends Entry implements \ArrayAccess, \IteratorAggregate
}
/**
- * Whether a offset exists
- * @param mixed $offset An offset to check for.
- * @return bool true on success or false on failure.
+ * Whether a offset exists.
+ *
+ * @param mixed $offset an offset to check for
+ *
+ * @return bool true on success or false on failure
*/
- public function offsetExists($offset)
+ public function offsetExists($offset): bool
{
return array_key_exists($offset, $this->children);
}
/**
- * Offset to retrieve
- * @param mixed $offset The offset to retrieve.
- * @return Entry Can return all value types.
+ * Offset to retrieve.
+ *
+ * @param mixed $offset the offset to retrieve
+ *
+ * @return Entry can return all value types
*/
public function offsetGet($offset)
{
@@ -278,10 +286,10 @@ class Directory extends Entry implements \ArrayAccess, \IteratorAggregate
}
/**
- * Offset to set
- * @param mixed $offset The offset to assign the value to.
- * @param Entry $value The value to set.
- * @return void
+ * Offset to set.
+ *
+ * @param mixed $offset the offset to assign the value to
+ * @param Entry $value the value to set
*/
public function offsetSet($offset, $value)
{
@@ -293,9 +301,9 @@ class Directory extends Entry implements \ArrayAccess, \IteratorAggregate
}
/**
- * Offset to unset
+ * Offset to unset.
+ *
* @param string $offset the offset to unset
- * @return void
*/
public function offsetUnset($offset)
{
diff --git a/libs/Tree/Entry.php b/libs/Tree/Entry.php
index 7543041..50a9060 100644
--- a/libs/Tree/Entry.php
+++ b/libs/Tree/Entry.php
@@ -23,7 +23,6 @@ abstract class Entry
protected $path;
/**
- * @param Directory $parent
* @param string $uri
* @param SplFileInfo $info
*/
@@ -81,15 +80,12 @@ abstract class Entry
/**
* @return string
*/
- public function getTitle()
+ public function getTitle(): ?string
{
return $this->title;
}
- /**
- * @param string $title
- */
- public function setTitle($title)
+ public function setTitle(string $title)
{
$this->title = $title;
}
@@ -97,13 +93,13 @@ abstract class Entry
/**
* @return Directory
*/
- public function getParent()
+ public function getParent(): ?Directory
{
return $this->parent;
}
/**
- * Return all parents starting with the root
+ * Return all parents starting with the root.
*
* @return Directory[]
*/
@@ -118,9 +114,6 @@ abstract class Entry
return $parents;
}
- /**
- * @param Directory $parent
- */
protected function setParent(Directory $parent)
{
if ($this->parent) {
@@ -134,17 +127,15 @@ abstract class Entry
/**
* @return string
*/
- public function getPath()
+ public function getPath(): ?string
{
return $this->path;
}
/**
- * Get the path to the file from the root of the documentation
- *
- * @return string
+ * Get the path to the file from the root of the documentation.
*/
- public function getRelativePath()
+ public function getRelativePath(): string
{
$root = $this;
while ($root->getParent() != null) {
@@ -154,18 +145,12 @@ abstract class Entry
return substr($this->path, strlen($root->getPath()) + 1);
}
- /**
- * @return SplFileInfo
- */
- public function getFileinfo()
+ public function getFileinfo(): SplFileInfo
{
return $this->info;
}
- /**
- * @return string
- */
- public function getUrl()
+ public function getUrl(): string
{
$url = '';
@@ -190,7 +175,8 @@ abstract class Entry
];
}
- public function isHotPath(Entry $node = null) {
+ public function isHotPath(Entry $node = null)
+ {
return $this->parent->isHotPath($node ?: $this);
}
}
diff --git a/libs/Tree/Root.php b/libs/Tree/Root.php
index b286ade..7c2dc04 100644
--- a/libs/Tree/Root.php
+++ b/libs/Tree/Root.php
@@ -11,7 +11,7 @@ class Root extends Directory
protected $activeNode;
/**
- * The root doesn't have a parent
+ * The root doesn't have a parent.
*/
public function __construct(Config $config)
{
@@ -21,23 +21,18 @@ class Root extends Directory
$this->path = $config->getDocumentationDirectory();
}
- /**
- * @return Config
- */
- public function getConfig()
+ public function getConfig(): Config
{
return $this->config;
}
- /**
- * @param Config $config
- */
- public function setConfig($config)
+ public function setConfig(Config $config)
{
$this->config = $config;
}
- public function isHotPath(Entry $node = null) {
+ public function isHotPath(Entry $node = null): bool
+ {
if ($node == null) {
return true;
}
@@ -51,7 +46,7 @@ class Root extends Directory
}
foreach ($this->activeNode->getParents() as $parent) {
- if ($node == $parent) {
+ if ($node === $parent) {
return true;
}
}
@@ -59,7 +54,8 @@ class Root extends Directory
return false;
}
- public function setActiveNode(Entry $node) {
+ public function setActiveNode(Entry $node)
+ {
$this->activeNode = $node;
}
}
diff --git a/libs/bootstrap.php b/libs/bootstrap.php
index 8e5b669..26b020d 100644
--- a/libs/bootstrap.php
+++ b/libs/bootstrap.php
@@ -1,6 +1,7 @@
setPsr4("Todaymade\\Daux\\Extension\\", $ext);
+ $loader->setPsr4('Todaymade\\Daux\\Extension\\', $ext);
}
diff --git a/package.json b/package.json
index d6ae45b..c09feb3 100644
--- a/package.json
+++ b/package.json
@@ -8,12 +8,14 @@
"@swissquote/crafty-preset-postcss": "^1.8.0",
"@swissquote/crafty-runner-gulp": "^1.8.0",
"@swissquote/crafty-runner-rollup": "^1.8.0",
- "flexsearch": "^0.6.30",
- "preact": "^10.0.0-rc.3"
+ "flexsearch": "^0.6.32",
+ "postcss-page-break": "^2.0.0",
+ "preact": "^10.0.5"
},
"scripts": {
"build": "crafty run",
"watch": "crafty watch",
+ "lint:js": "crafty jsLint --fix src/js/**/*.js",
"lint:css": "crafty cssLint --fix --preset recommended themes/daux_singlepage/scss/*.scss themes/daux/scss/*.scss"
}
}
diff --git a/renovate.json b/renovate.json
new file mode 100644
index 0000000..baa87b7
--- /dev/null
+++ b/renovate.json
@@ -0,0 +1,8 @@
+{
+ "extends": [
+ "config:base",
+ "group:allNonMajor",
+ ":preserveSemverRanges",
+ "schedule:weekends"
+ ]
+}
diff --git a/scripts/fix_report.php b/scripts/fix_report.php
new file mode 100644
index 0000000..4f568d5
--- /dev/null
+++ b/scripts/fix_report.php
@@ -0,0 +1,52 @@
+loadXML($report);
+
+function hasDataSetTestCase(DomNode $node) {
+ foreach ($node->childNodes as $child) {
+ if ($child->nodeName === "testcase" && strpos($child->attributes->getNamedItem("name")->textContent, "with data set #" ) !== false) {
+ return $child;
+ }
+ }
+
+ return false;
+}
+
+function drillDownTestSuite(DomDocument $document, DomNode $node) {
+ if ($dataset = hasDataSetTestCase($node)) {
+ $childAttributes = $dataset->attributes;
+ $nodeAttributes= $node->attributes;
+
+ $case = $document->createElement('testcase');
+ $case->setAttribute('name', $childAttributes->getNamedItem('name')->textContent);
+ $case->setAttribute('class', $childAttributes->getNamedItem('class')->textContent);
+ $case->setAttribute('classname', $childAttributes->getNamedItem('classname')->textContent);
+ $case->setAttribute('file', $childAttributes->getNamedItem('file')->textContent);
+ $case->setAttribute('line', $childAttributes->getNamedItem('line')->textContent);
+ $case->setAttribute('assertions', $nodeAttributes->getNamedItem('assertions')->textContent);
+ $case->setAttribute('time', $nodeAttributes->getNamedItem('time')->textContent);
+
+ $node->parentNode->replaceChild($case, $node);
+ return true;
+ }
+
+ /** @var DomNode $child */
+ for ($i=0; $i< $node->childNodes->length; $i++) {
+ $child = $node->childNodes->item($i);
+ if ($child->localName === "testsuite") {
+ if (drillDownTestSuite($document, $child)) {
+ $i--;
+ }
+ }
+ }
+
+ return false;
+}
+
+drillDownTestSuite($doc, $doc->firstChild);
+
+file_put_contents(dirname(__DIR__) . "/test-report.xml", $doc->saveXML());
+echo "Done\n";
diff --git a/scripts/fix_reports.sh b/scripts/fix_reports.sh
new file mode 100755
index 0000000..90ab60c
--- /dev/null
+++ b/scripts/fix_reports.sh
@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+# https://community.sonarsource.com/t/code-coverage-doesnt-work-with-github-action/16747/5
+echo "fix code coverage paths"
+sed -i 's/\/home\/runner\/work\/daux.io\/daux.io\//\/github\/workspace\//g' coverage.clover
+
+php scripts/fix_report.php
diff --git a/scripts/install_tools.sh b/scripts/install_tools.sh
new file mode 100755
index 0000000..b9e4fe0
--- /dev/null
+++ b/scripts/install_tools.sh
@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+
+if [ ! -d build ]; then
+ mkdir build;
+fi
+
+echo "-- Install phpunit"
+curl -sSLo build/phpunit https://phar.phpunit.de/phpunit-8.phar
+chmod +x build/phpunit
+
+echo "-- Install php-cs-fixer"
+curl -sSLo build/php-cs-fixer https://github.com/FriendsOfPHP/PHP-CS-Fixer/releases/download/v2.16.3/php-cs-fixer.phar
+chmod +x build/php-cs-fixer
diff --git a/sonar-project.properties b/sonar-project.properties
new file mode 100644
index 0000000..f818211
--- /dev/null
+++ b/sonar-project.properties
@@ -0,0 +1,10 @@
+sonar.projectKey=dauxio_daux.io
+sonar.organization=daux
+sonar.projectName=Daux.io
+
+sonar.sources=.
+sonar.exclusions=vendor/**,tests/**
+sonar.test.inclusions=tests/**
+
+sonar.php.coverage.reportPaths=coverage.clover
+sonar.php.tests.reportPath=test-report.xml
diff --git a/src/css/theme_daux/_components.scss b/src/css/theme_daux/_components.scss
index 98cae53..6537068 100644
--- a/src/css/theme_daux/_components.scss
+++ b/src/css/theme_daux/_components.scss
@@ -35,7 +35,7 @@ Components
display: inline-block;
text-align: center;
vertical-align: middle;
- touch-action: manipulation;
+ touch-action: manipulation; // stylelint-disable-line plugin/no-unsupported-browser-features
cursor: pointer;
background-image: none; // Reset unusual Firefox-on-Android default style; see https://github.com/necolas/normalize.css/issues/214
border: 1px solid transparent;
@@ -99,7 +99,8 @@ Components
}
/* stylelint-disable-next-line selector-class-pattern */
-.no-js .CodeToggler {
+.no-js .CodeToggler,
+.CodeToggler--hidden {
display: none;
}
@@ -249,7 +250,6 @@ Components
display: inline-block;
vertical-align: top;
- zoom: 1;
position: relative;
height: 20px;
@@ -264,7 +264,6 @@ Components
.Twitter__button__label {
display: inline-block;
vertical-align: top;
- zoom: 1;
margin-left: 3px;
white-space: nowrap;
@@ -301,7 +300,7 @@ Components
&:focus {
border-color: var(--search-field-hover-border-color);
- outline: 0;
+ outline: 0; // stylelint-disable-line plugin/no-unsupported-browser-features
}
}
@@ -311,6 +310,7 @@ Components
top: 9px;
width: 16px;
height: 16px;
+ cursor: pointer;
}
}
@@ -477,7 +477,3 @@ ul.TableOfContents {
border-color: var(--checkbox-disabled-tick-color);
}
}
-
-.Hidden {
- display: none;
-}
diff --git a/src/css/theme_daux/_fonts.scss b/src/css/theme_daux/_fonts.scss
index 755d61f..4ff70fd 100644
--- a/src/css/theme_daux/_fonts.scss
+++ b/src/css/theme_daux/_fonts.scss
@@ -20,6 +20,7 @@
url("../fonts/robotoslab-light.woff") format("woff"),
url("../fonts/robotoslab-light.ttf") format("truetype"),
url("../fonts/robotoslab-light.svg#roboto_slablight") format("svg");
+ // stylelint-disable-next-line plugin/no-unsupported-browser-features
unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02C6, U+02DA, U+02DC,
U+2000-206F, U+2074, U+20AC, U+2212, U+2215;
}
@@ -36,6 +37,7 @@
url("../fonts/robotoslab-regular.woff") format("woff"),
url("../fonts/robotoslab-regular.ttf") format("truetype"),
url("../fonts/robotoslab-regular.svg#roboto_slabregular") format("svg");
+ // stylelint-disable-next-line plugin/no-unsupported-browser-features
unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02C6, U+02DA, U+02DC,
U+2000-206F, U+2074, U+20AC, U+2212, U+2215;
}
@@ -51,6 +53,7 @@
url("../fonts/robotoslab-bold.woff") format("woff"),
url("../fonts/robotoslab-bold.ttf") format("truetype"),
url("../fonts/robotoslab-bold.svg#roboto_slabbold") format("svg");
+ // stylelint-disable-next-line plugin/no-unsupported-browser-features
unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02C6, U+02DA, U+02DC,
U+2000-206F, U+2074, U+20AC, U+2212, U+2215;
}
diff --git a/src/css/theme_daux/_mixins.scss b/src/css/theme_daux/_mixins.scss
index 6ced5e5..aea126e 100644
--- a/src/css/theme_daux/_mixins.scss
+++ b/src/css/theme_daux/_mixins.scss
@@ -4,7 +4,7 @@ Mixins
@mixin kill-background-image {
background-image: none;
- filter: none;
+ filter: none; // stylelint-disable-line plugin/no-unsupported-browser-features
}
@mixin kill-box-shadow {
diff --git a/src/css/theme_daux/_print.scss b/src/css/theme_daux/_print.scss
index e93d21b..ec193ed 100644
--- a/src/css/theme_daux/_print.scss
+++ b/src/css/theme_daux/_print.scss
@@ -11,19 +11,19 @@ h3,
h4,
h5,
h6 {
- page-break-after: avoid;
- page-break-before: auto;
+ break-after: avoid; // stylelint-disable-line plugin/no-unsupported-browser-features
+ break-before: auto; // stylelint-disable-line plugin/no-unsupported-browser-features
}
pre,
blockquote {
border: 1px solid #999;
font-style: italic;
- page-break-inside: avoid;
+ break-inside: avoid; // stylelint-disable-line plugin/no-unsupported-browser-features
}
img {
- page-break-inside: avoid;
+ break-inside: avoid; // stylelint-disable-line plugin/no-unsupported-browser-features
border: 0; /* Some browsers like to show a border around images. Switch it off */
}
@@ -50,7 +50,7 @@ q {
.PageBreak {
display: block;
- page-break-before: always;
+ break-before: always; // stylelint-disable-line plugin/no-unsupported-browser-features
}
.NoPrint {
diff --git a/src/css/theme_daux/_structure.scss b/src/css/theme_daux/_structure.scss
index 12bf5f2..c4d4c3b 100644
--- a/src/css/theme_daux/_structure.scss
+++ b/src/css/theme_daux/_structure.scss
@@ -148,3 +148,13 @@ body {
// 860 == screen-width of 1200 - sidebar - margin
max-width: 860px;
}
+
+.u-visuallyHidden {
+ position: absolute !important;
+ height: 1px;
+ width: 1px;
+ overflow: hidden;
+ clip: rect(1px 1px 1px 1px); /* IE6, IE7 */
+ clip: rect(1px, 1px, 1px, 1px);
+ white-space: nowrap; /* added line */
+}
diff --git a/src/css/theme_daux/_typography.scss b/src/css/theme_daux/_typography.scss
index bbbcb7a..9743c12 100644
--- a/src/css/theme_daux/_typography.scss
+++ b/src/css/theme_daux/_typography.scss
@@ -6,8 +6,8 @@ body {
line-height: 1.5;
font-family: var(--font-family-text);
- font-feature-settings: "kern" 1;
- font-kerning: normal;
+ font-feature-settings: "kern" 1; // stylelint-disable-line plugin/no-unsupported-browser-features
+ font-kerning: normal; // stylelint-disable-line plugin/no-unsupported-browser-features
-webkit-font-smoothing: antialiased;
-moz-osx-font-smoothing: grayscale;
}
@@ -189,8 +189,7 @@ h6 {
img {
max-width: 100%;
- display: block;
- margin: 0 auto;
+ display: inline-block;
}
code {
diff --git a/src/css/theme_daux_singlepage/_fonts.scss b/src/css/theme_daux_singlepage/_fonts.scss
index 755d61f..4ff70fd 100644
--- a/src/css/theme_daux_singlepage/_fonts.scss
+++ b/src/css/theme_daux_singlepage/_fonts.scss
@@ -20,6 +20,7 @@
url("../fonts/robotoslab-light.woff") format("woff"),
url("../fonts/robotoslab-light.ttf") format("truetype"),
url("../fonts/robotoslab-light.svg#roboto_slablight") format("svg");
+ // stylelint-disable-next-line plugin/no-unsupported-browser-features
unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02C6, U+02DA, U+02DC,
U+2000-206F, U+2074, U+20AC, U+2212, U+2215;
}
@@ -36,6 +37,7 @@
url("../fonts/robotoslab-regular.woff") format("woff"),
url("../fonts/robotoslab-regular.ttf") format("truetype"),
url("../fonts/robotoslab-regular.svg#roboto_slabregular") format("svg");
+ // stylelint-disable-next-line plugin/no-unsupported-browser-features
unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02C6, U+02DA, U+02DC,
U+2000-206F, U+2074, U+20AC, U+2212, U+2215;
}
@@ -51,6 +53,7 @@
url("../fonts/robotoslab-bold.woff") format("woff"),
url("../fonts/robotoslab-bold.ttf") format("truetype"),
url("../fonts/robotoslab-bold.svg#roboto_slabbold") format("svg");
+ // stylelint-disable-next-line plugin/no-unsupported-browser-features
unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02C6, U+02DA, U+02DC,
U+2000-206F, U+2074, U+20AC, U+2212, U+2215;
}
diff --git a/src/css/theme_daux_singlepage/_print.scss b/src/css/theme_daux_singlepage/_print.scss
index 9599166..bce61b2 100755
--- a/src/css/theme_daux_singlepage/_print.scss
+++ b/src/css/theme_daux_singlepage/_print.scss
@@ -11,19 +11,19 @@ h3,
h4,
h5,
h6 {
- page-break-after: avoid;
- page-break-before: auto;
+ break-after: avoid; // stylelint-disable-line plugin/no-unsupported-browser-features
+ break-before: auto; // stylelint-disable-line plugin/no-unsupported-browser-features
}
pre,
blockquote {
border: 1px solid #999;
font-style: italic;
- page-break-inside: avoid;
+ break-inside: avoid; // stylelint-disable-line plugin/no-unsupported-browser-features
}
img {
- page-break-inside: avoid;
+ break-inside: avoid; // stylelint-disable-line plugin/no-unsupported-browser-features
border: 0; /* Some browsers like to show a border around images. Switch it off */
}
@@ -50,7 +50,7 @@ q {
.PageBreak {
display: block;
- page-break-before: always;
+ break-before: always; // stylelint-disable-line plugin/no-unsupported-browser-features
}
.NoPrint {
diff --git a/src/css/theme_daux_singlepage/main.scss b/src/css/theme_daux_singlepage/main.scss
index a22208d..3f98c9f 100755
--- a/src/css/theme_daux_singlepage/main.scss
+++ b/src/css/theme_daux_singlepage/main.scss
@@ -15,7 +15,7 @@ body {
}
body {
- text-rendering: optimizeLegibility;
+ text-rendering: optimizeLegibility; // stylelint-disable-line plugin/no-unsupported-browser-features
-webkit-font-smoothing: antialiased;
-moz-osx-font-smoothing: grayscale;
font-family: var(--font-family-text);
diff --git a/src/js/search/index.js b/src/js/search/index.js
index 2922a0c..6277a2e 100644
--- a/src/js/search/index.js
+++ b/src/js/search/index.js
@@ -23,6 +23,7 @@ class SearchEngine {
constructor(options) {
this.settings = {
field: document.getElementById("search_input"),
+ form: document.getElementById("search_form"),
show: 10,
showURL: true,
showTitleCount: true,
@@ -30,7 +31,7 @@ class SearchEngine {
descriptiveWords: 25,
highlightTerms: true,
highlightEveryTerm: false,
- contentLocation: "daux_search_index.json",
+ contentLocation: "daux_search_index.js",
...options
};
@@ -41,30 +42,37 @@ class SearchEngine {
loadData() {
if (!this.loadingPromise) {
- this.loadingPromise = fetch(
- this.settings.base_url + this.settings.contentLocation
- )
- .then(data => data.json())
- .then(json => {
- this.searchIndex = new FlexSearch({
- doc: {
- id: "url",
- field: ["title", "text", "tags"]
- }
- });
+ // We do this as jsonp instead of an XHR or fetch request
+ // to be compatible with usage from filesystem
+ const po = document.createElement("script");
+ po.type = "text/javascript";
+ po.async = true;
+ po.src = this.settings.base_url + this.settings.contentLocation;
+ const s = document.getElementsByTagName("script")[0];
+ s.parentNode.insertBefore(po, s);
- let pages = json.pages;
-
- // Only keep the pages related to the current language
- if (window.searchLanguage) {
- const pagePrefix = `${window.searchLanguage}/`;
- pages = pages.filter(
- item => item.url.indexOf(pagePrefix) === 0
- );
+ this.loadingPromise = new Promise(resolve => {
+ window.load_search_index = data => resolve(data);
+ }).then(json => {
+ this.searchIndex = new FlexSearch({
+ doc: {
+ id: "url",
+ field: ["title", "text", "tags"]
}
-
- this.searchIndex.add(pages);
});
+
+ let pages = json.pages;
+
+ // Only keep the pages related to the current language
+ if (window.searchLanguage) {
+ const pagePrefix = `${window.searchLanguage}/`;
+ pages = pages.filter(
+ item => item.url.indexOf(pagePrefix) === 0
+ );
+ }
+
+ this.searchIndex.add(pages);
+ });
}
return this.loadingPromise;
@@ -89,6 +97,13 @@ class SearchEngine {
});
}
});
+
+ this.settings.form.addEventListener("submit", event => {
+ event.preventDefault();
+ this.loadData().then(() => {
+ this.displaySearch();
+ });
+ });
}
keyUpHandler = e => {
diff --git a/src/js/theme_daux/code_toggle.js b/src/js/theme_daux/code_toggle.js
index b302e7f..cd230f1 100644
--- a/src/js/theme_daux/code_toggle.js
+++ b/src/js/theme_daux/code_toggle.js
@@ -1,11 +1,10 @@
-const codeBlocks = document.querySelectorAll(".s-content pre");
-const toggleCodeSection = document.querySelector(".CodeToggler");
+import { ready } from "./utils";
const LOCAL_STORAGE_KEY = "daux_code_blocks_hidden";
-function setCodeBlockStyle(hidden) {
+function setCodeBlockStyle(codeBlocks, hidden) {
for (let a = 0; a < codeBlocks.length; a++) {
- codeBlocks[a].classList.toggle("Hidden", hidden);
+ codeBlocks[a].classList.toggle("CodeToggler--hidden", hidden);
}
try {
localStorage.setItem(LOCAL_STORAGE_KEY, hidden);
@@ -14,7 +13,7 @@ function setCodeBlockStyle(hidden) {
}
}
-function enableToggler() {
+function enableToggler(toggleCodeSection, codeBlocks) {
const toggleCodeBlockBtnSet = toggleCodeSection.querySelector(
".CodeToggler__button--main"
); // available when floating is disabled
@@ -22,7 +21,7 @@ function enableToggler() {
toggleCodeBlockBtnSet.addEventListener(
"change",
ev => {
- setCodeBlockStyle(!ev.target.checked);
+ setCodeBlockStyle(codeBlocks, !ev.target.checked);
},
false
);
@@ -38,7 +37,7 @@ function enableToggler() {
}
if (hidden) {
- setCodeBlockStyle(!!hidden);
+ setCodeBlockStyle(codeBlocks, !!hidden);
toggleCodeBlockBtnSet.checked = !hidden;
}
} catch (e) {
@@ -46,10 +45,17 @@ function enableToggler() {
}
}
-if (toggleCodeSection) {
- if (codeBlocks.length) {
- enableToggler();
- } else {
- toggleCodeSection.classList.add("Hidden");
+ready(() => {
+ const codeBlocks = document.querySelectorAll(".s-content pre");
+ const toggleCodeSection = document.querySelector(".CodeToggler");
+
+ if (!toggleCodeSection) {
+ return;
}
-}
+
+ if (codeBlocks.length) {
+ enableToggler(toggleCodeSection, codeBlocks);
+ } else {
+ toggleCodeSection.classList.add("CodeToggler--hidden");
+ }
+});
diff --git a/src/js/theme_daux/hamburger.js b/src/js/theme_daux/hamburger.js
index 45b0663..5aee5c3 100644
--- a/src/js/theme_daux/hamburger.js
+++ b/src/js/theme_daux/hamburger.js
@@ -1,18 +1,22 @@
-const trigger = document.querySelector(".Collapsible__trigger");
+import { ready } from "./utils";
-if (trigger) {
- const content = document.querySelector(".Collapsible__content");
+ready(() => {
+ const trigger = document.querySelector(".Collapsible__trigger");
- trigger.addEventListener("click", ev => {
- if (content.classList.contains("Collapsible__content--open")) {
- content.style.height = 0;
- content.classList.remove("Collapsible__content--open");
- trigger.setAttribute("aria-expanded", "false");
- } else {
- trigger.setAttribute("aria-expanded", "true");
- content.style.transitionDuration = "150ms";
- content.style.height = `${content.scrollHeight}px`;
- content.classList.add("Collapsible__content--open");
- }
- });
-}
+ if (trigger) {
+ const content = document.querySelector(".Collapsible__content");
+
+ trigger.addEventListener("click", ev => {
+ if (content.classList.contains("Collapsible__content--open")) {
+ content.style.height = 0;
+ content.classList.remove("Collapsible__content--open");
+ trigger.setAttribute("aria-expanded", "false");
+ } else {
+ trigger.setAttribute("aria-expanded", "true");
+ content.style.transitionDuration = "150ms";
+ content.style.height = `${content.scrollHeight}px`;
+ content.classList.add("Collapsible__content--open");
+ }
+ });
+ }
+});
diff --git a/src/js/theme_daux/highlight.js b/src/js/theme_daux/highlight.js
index a0c8ef3..0de2622 100644
--- a/src/js/theme_daux/highlight.js
+++ b/src/js/theme_daux/highlight.js
@@ -1,12 +1,16 @@
-const codeBlocks = document.querySelectorAll("pre > code:not(.hljs)");
-if (codeBlocks.length) {
- const head = document.getElementsByTagName("head")[0],
- script = document.createElement("script");
- script.type = "text/javascript";
- script.async = true;
- script.src = `${window.base_url}daux_libraries/highlight.pack.js`;
- script.onload = function(src) {
- [].forEach.call(codeBlocks, window.hljs.highlightBlock);
- };
- head.appendChild(script);
-}
+import { ready } from "./utils";
+
+ready(() => {
+ const codeBlocks = document.querySelectorAll("pre > code:not(.hljs)");
+ if (codeBlocks.length) {
+ const head = document.getElementsByTagName("head")[0],
+ script = document.createElement("script");
+ script.type = "text/javascript";
+ script.async = true;
+ script.src = `${window.base_url}daux_libraries/highlight.pack.js`;
+ script.onload = function(src) {
+ [].forEach.call(codeBlocks, window.hljs.highlightBlock);
+ };
+ head.appendChild(script);
+ }
+});
diff --git a/src/js/theme_daux/menu.js b/src/js/theme_daux/menu.js
index 06a4948..de0b067 100644
--- a/src/js/theme_daux/menu.js
+++ b/src/js/theme_daux/menu.js
@@ -1,3 +1,5 @@
+import { ready } from "./utils";
+
/**
* After the transition finishes set the height to auto so child
* menus can expand properly.
@@ -56,24 +58,28 @@ function toggleSubMenu(ev) {
}
}
-const navItems = document.querySelectorAll(
- ".Nav__item.has-children i.Nav__arrow"
-);
+ready(() => {
+ const navItems = document.querySelectorAll(
+ ".Nav__item.has-children i.Nav__arrow"
+ );
-// Go in reverse here because on page load the child nav items need to be
-// opened first before their parents so the height on the parents can be
-// calculated properly.
-for (let i = navItems.length - 1, target; i >= 0; i--) {
- target = navItems[i];
- target.addEventListener("click", toggleSubMenu);
+ // Go in reverse here because on page load the child nav items need to be
+ // opened first before their parents so the height on the parents can be
+ // calculated properly.
+ for (let i = navItems.length - 1, target; i >= 0; i--) {
+ target = navItems[i];
+ target.addEventListener("click", toggleSubMenu);
- if (target.parentNode.parentNode.classList.contains("Nav__item--open")) {
- toggleSubMenu({ target });
+ if (
+ target.parentNode.parentNode.classList.contains("Nav__item--open")
+ ) {
+ toggleSubMenu({ target });
+ }
}
-}
-// Some navigations just have sub-pages without having a page by themselves
-const ajNav = document.querySelectorAll(".Nav__item__link--nopage");
-for (const navItem of ajNav) {
- navItem.addEventListener("click", toggleSubMenu);
-}
+ // Some navigations just have sub-pages without having a page by themselves
+ const ajNav = document.querySelectorAll(".Nav__item__link--nopage");
+ for (const navItem of ajNav) {
+ navItem.addEventListener("click", toggleSubMenu);
+ }
+});
diff --git a/src/js/theme_daux/utils.js b/src/js/theme_daux/utils.js
new file mode 100644
index 0000000..6a1d97c
--- /dev/null
+++ b/src/js/theme_daux/utils.js
@@ -0,0 +1,9 @@
+/* eslint-disable @swissquote/swissquote/import/prefer-default-export */
+
+export function ready(fn) {
+ if (document.readyState === "loading") {
+ document.addEventListener("DOMContentLoaded", fn);
+ } else {
+ fn();
+ }
+}
diff --git a/templates/content.php b/templates/content.php
index c710bec..862f139 100644
--- a/templates/content.php
+++ b/templates/content.php
@@ -3,13 +3,13 @@
+ $hasPrevNext = (!empty($page['prev']) || !empty($page['next']));
+ if ($hasPrevNext && $config->getHTML()->showPreviousNextLinks()) {
+ ?>
+ } ?>
diff --git a/templates/home.php b/templates/home.php
index e253793..9145158 100755
--- a/templates/home.php
+++ b/templates/home.php
@@ -4,31 +4,32 @@
' .
"
{$this->cover['title']}
" . "{$this->cover['subject']} by {$this->cover['author']}
" . 'get_breadcrumb_title($page, $base_page) : $page['title'] ?>
- + getHTML()->showDateModified()) { ?> - + getHTML()->getEditOn(); + $edit_on = $config->getHTML()->getEditOn(); if ($edit_on) { ?> @@ -24,24 +24,20 @@
- ' . $params['tagline'] . '' : '' ?>
+ hasTagline()) ? '
' . $config->getTagline() . '
' : '' ?>
- ' : '' ?>
+ hasImage()) ? ' . ')
' : '' ?>
- ' . $this->translate("View_on_github") . '';
- }
+ getHTML()->hasRepository()) { ?>
+
+ translate("View_on_github") ?>
+
+ translate("View_documentation");
foreach ($page['entry_page'] as $key => $node) {
echo '' . str_replace("__VIEW_DOCUMENTATION__", $view_doc, $key) . '';
}
- if(isset($params['html']['buttons']) && is_array($params['html']['buttons'])) {
- foreach ($params['html']['buttons'] as $name => $link ) {
+ if ($config->getHTML()->hasButtons()) {
+ foreach ($config->getHTML()->getButtons() as $name => $link) {
echo '' . $name . '';
}
}
@@ -50,18 +51,18 @@