Release Notes
Upgrading
To upgrade MkDocs to the latest version, use pip:
pip install -U mkdocs
You can determine your currently installed version using mkdocs --version
:
$ mkdocs --version
mkdocs, version 1.0 from /path/to/mkdocs (Python 3.6)
Maintenance team
The current and past members of the MkDocs team.
Version 1.2.2 (2021-07-18)
-
Bugfix (regression in 1.2): Fix serving files/paths with Unicode characters (#2464)
-
Bugfix (regression in 1.2): Revert livereload file watching to use polling observer (#2477)
This had to be done to reasonably support usages that span virtual filesystems such as non-native Docker and network mounts.
This goes back to the polling approach, very similar to that was always used prior, meaning most of the same downsides with latency and CPU usage.
-
Revert from 1.2: Remove the requirement of a
site_url
config and the restriction onuse_directory_urls
(#2490) -
Bugfix (regression in 1.2): Don’t require trailing slash in the URL when serving a directory index in
mkdocs serve
server (#2507)Instead of showing a 404 error, detect if it’s a directory and redirect to a path with a trailing slash added, like before.
-
Bugfix: Fix
gh_deploy
with config-file in the current directory (#2481) -
Bugfix: Fix reversed breadcrumbs in “readthedocs” theme (#2179)
-
Allow “mkdocs.yaml” as the file name when ‘–config’ is not passed (#2478)
-
Stop treating “;” as a special character in URLs: urlparse -> urlsplit (#2502)
-
Improve build performance for sites with many pages (partly already done in 1.2) (#2407)
Version 1.2.1 (2021-06-09)
- Bugfix (regression in 1.2): Ensure ‘gh-deploy’ always pushes.
Version 1.2 (2021-06-04)
Major Additions to Version 1.2
Support added for Theme Localization (#2299)
The mkdocs
and readthedocs
themes now support language localization using
the theme.locale
parameter, which defaults to en
(English). The only other
supported languages in this release are fr
(French) and es
(Spanish). For
details on using the provided translations, see the user
guide. Note that translation will not
happen by default. Users must first install the necessary dependencies with
the following command:
pip install mkdocs[i18n]
Translation contributions are welcome and detailed in the Translation Guide.
Developers of third party themes may want to review the relevant section of the Theme Development Guide.
Contributors who are updating the templates to the built-in themes should review the Contributing Guide.
The lang
setting of the search
plugin now defaults to the language
specified in theme.locale
.
Support added for Environment Variables in the configuration file (#1954)
Environments variables may now be specified in the configuration file with the
!ENV
tag. The value of the variable will be parsed by the YAML parser and
converted to the appropriate type.
somekey: !ENV VAR_NAME
otherkey: !ENV [VAR_NAME, FALLBACK_VAR, 'default value']
See Environment Variables in the Configuration documentation for details.
Support added for Configuration Inheritance (#2218)
A configuration file may now inherit from a parent configuration file. In the
primary file set the INHERIT
key to the relative path of the parent file.
INHERIT: path/to/base.yml
The two files will then be deep merged. See Configuration Inheritance for details.
Update gh-deploy
command (#2170)
The vendored (and modified) copy of ghp_import has been replaced with a dependency on the upstream library. As of version 1.0.0, ghp-import includes a Python API which makes it possible to call directly.
MkDocs can now benefit from recent bug fixes and new features, including the following:
- A
.nojekyll
file is automatically included when deploying to GitHub Pages. - The
--shell
flag is now available, which reportedly works better on Windows. - Git author and committer environment variables should be respected (#1383).
Rework auto-reload and HTTP server for mkdocs serve
(#2385)
mkdocs serve
now uses a new underlying server + file watcher implementation,
based on http.server from standard library and watchdog. It provides similar
functionality to the previously used livereload library (which is now dropped
from dependencies, along with tornado).
This makes reloads more responsive and consistent in terms of timing. Multiple rapid file changes no longer cause the site to repeatedly rebuild (issue #2061).
Almost every aspect of the server is slightly different, but actual visible changes are minor. The logging outputs are only similar to the old ones. Degradations in behavior are not expected, and should be reported if found.
Offset the local site root according to the sub-path of the site_url
(#2424)
When using mkdocs serve
and having the site_url
specified as e.g.
http://example.org/sub/path/
, now the root of the locally served site
becomes http://<IP_ADDRESS>:8000/sub/path/
and all document paths are offset
accordingly.
A build_error
event was added (#2103)
Plugin developers can now use the on_build_error
hook
to execute code when an exception is raised while building the site.
See on_build_error
in the Plugins documentation for details.
Three new exceptions: BuildError PluginError and Abort (#2103)
MkDocs now has tree new exceptions defined in mkdocs.exceptions
:
BuildError
, PluginError
, and Abort
:
PluginError
can be raised from a plugin to stop the build and log an error message without traceback.BuildError
should not be used by third-party plugins developers and is reserved for internal use only.Abort
is used internally to abort the build and display an error without a traceback.
See Handling errors
in the Plugins documentation for details.
Search Indexing Strategy configuration
Users can now specify which strategy they wish to use when indexing their site for search. A user can select between the following options:
- full: Adds page title, section headings, and full page text to the search index.
- sections: Adds page titles and section headings only to the search index.
- titles: Adds only the page titles to the search index.
See Search Indexing
in the
configuration documentation for details.
Backward Incompatible Changes in 1.2
-
The site_url configuration option is now required. If it is not set, a warning will be issued. In a future release an error will be raised (#2189).
The use_directory_urls configuration option will be forced to
false
if site_url is set to an empty string. In that case, ifuse_directory_urls
is not explicitly set tofalse
, a warning will be issued (#2189).!!! note This was reverted in release 1.2.2
-
The
google_analytics
configuration option is deprecated as Google appears to be fazing it out in favor of its new Google Analytics 4 property. See the documentation for your theme for alternatives which can be configured as part of your theme configuration. For example, the mkdocs and readthedocs themes have each added a newtheme.analytics.gtag
configuration option which uses the new Google Analytics 4 property. See Google’s documentation on how to Upgrade to a Google Analytics 4 property. Then settheme.analytics.gtag
to the “G-” ID and delete thegoogle_analytics
configuration option which contains a “UA-” ID. So long as the old “UA-” ID and new “G-” ID are properly linked in your Google account, and you are using the “G-” ID, the data will be made available in both the old and new formats by Google Analytics. See #2252. -
A theme’s files are now excluded from the list of watched files by default when using the
--livereload
server. This new default behavior is what most users need and provides better performance when editing site content. Theme developers can enable the old behavior with the--watch-theme
option. (#2092). -
The
mkdocs
theme now removes the sidebar when printing a page. This frees up horizontal space for better rendering of content like tables (#2193). -
The
mkdocs.config.DEFAULT_SCHEMA
global variable has been replaced with the functionmkdocs.config.defaults.get_schema()
, which ensures that each instance of the configuration is unique (#2289). -
The
mkdocs.utils.warning_filter
is deprecated and now does nothing. Plugins should remove any reference to is as it may be deleted in a future release. To ensure any warnings get counted, simply log them to themkdocs
log (i.e.:mkdocs.plugins.pluginname
). -
The
on_serve
event (which receives theserver
object and thebuilder
function) is affected by the server rewrite.server
is now amkdocs.livereload.LiveReloadServer
instead oflivereload.server.Server
. The typical action that plugins can do with these is to callserver.watch(some_dir, builder)
, which basically adds that directory to watched directories, causing the site to be rebuilt on file changes. That still works, but passing any other function towatch
is deprecated and shows a warning. This 2nd parameter is already optional, and will accept only this exactbuilder
function just for compatibility. -
The
python
method of theplugins.search.prebuild_index
configuration option is pending deprecation as of version 1.2. It is expected that in version 1.3 it will raise a warning if used and in version 1.4 it will raise an error. Users are encouraged to use an alternate method to generate a prebuilt index for search. -
The
lunr
andlunr[languages]
dependencies are no longer installed by default. The dependencies are only needed for the rare user who pre-builds the search index and uses thepython
option, which is now pending deprecation. If you use this feature, then you will need to manually installlunr
andlunr[languages]
. A warning is issued if the dependencies are needed but not installed.
Other Changes and Additions to Version 1.2
- Bugfix: Properly process navigation child items in
_get_by_type
when filtering for sections (#2203). - Official support for Python 3.9 has been added and support for Python 3.5 has been dropped.
- Bugfix: Fixes an issue that would result in a partially cut-off navigation item in the ReadTheDocs theme (#2297).
- Structure Files object now has a
remove
method to help plugin developers manipulate the Files tree. The correspondingsrc_paths
has become a property to accommodate this possible dynamic behavior. See #2305. - Updated highlight.js to 10.5.0. See #2313.
- Bugfix: Search plugin now works with Japanese language. See #2178.
- Documentation has been refactored (#1629).
- Restore styling of tables in the
readthedocs
theme (#2028). - Ensure
site_url
ends with a slash (#1785). - Correct documentation of
pages
template context variable (#1736). - The
lunr
dependency has been updated to 0.5.9, andlunr.js
to the corresponding 2.3.9 version (#2306). - Color is now used in log messages to identify errors, warnings and debug messages.
- Bugfix: Identify homepage when
use_directory_urls
isFalse
(#2362).
Version 1.1.2 (2020-05-14)
- Bugfix: Normalize IP addresses and change unsupported address error to a warning (#2108).
Version 1.1.1 (2020-05-12)
- Bugfix: Allow compressed sitemap to be deterministic by supporting the
SOURCE_DATE_EPOCH
environment variable (#2100). - Bugfix: Use
README.md
asindex.html
even ifuse_directory_urls
is false (#2081). - Bugfix: Ignore links which start with a backslash (#1680).
- Bugfix: Pass
builder
to theon_serve
event so that it can be passed toserver.watch
by plugins (#1952). - Bugfix: Use
lunr[languages]==0.5.8
to avoidnltk
incompatibilities (#2062). - Bugfix: Ensure wheel is Python 3 only (#2021).
- Bugfix: Clean up
dev_addr
validation and disallow<IP_ADDRESS>
(#2022). - Add support for
min_search_length
parameter for search plugin (#2014). - Bugfix:
readthedocs
themecode
colors (#2027).
Version 1.1 (2020-02-22)
Major Additions to Version 1.1
Support for Lunr.py as prebuild_index
engine
Mkdocs now supports pre-building indices using Lunr.py, a pure
Python implementation of Lunr.js, allowing the user to avoid installing a
NodeJS environment if so desired. For more information please read the
prebuild_index
documentation.
readthedocs
theme updated with upstream (#588 and #1374)
The readthedocs
theme now more closely matches the upstream Sphinx theme
(version 0.4.1). A number of new theme configuration settings were added which
mirror the upstream configuration options. See the theme
documentation for details.
Update mkdocs
theme to Bootswatch 4.1.3 (#1563)
The mkdocs
theme now supports all the features of Bootswatch 4.1.
Additionally, 2 filenames were changed in this update. If you are using a theme
which inherits from the mkdocs
theme, the theme developer may need to update
these filenames as follows.
css/bootstrap-custom.min.css => css/bootstrap.min.css
js/bootstrap-3.0.3.min.js => js/bootstrap.min.js
Improved configuration support on the command line (#1401)
The build
, serve
, and gh-deploy
subcommands now support flags to control
whether directory URLs should be created:
--use-directory-urls
/ --no-directory-urls
. In addition, the gh-deploy
subcommand now supports all the configuration options that build
and serve
do, adding --strict
, --theme
, --theme-dir
, and --site-dir
.
Updated lunr-languages support (#1729)
The lunr-languages
plugin has been updated to 1.4.0, adding support for
Arabic (ar
) and Vietnamese (vi
) languages. In addition, the Dutch and
Japanese language codes have been changed to their standard values: nl
and
ja
, respectively. The old language codes (du
and jp
) remain as aliases but
may be removed in a future version of MkDocs.
Other Changes and Additions to Version 1.1
- Bugfix: Ensure nested dot files in themes are ignored and document behavior (#1981).
- Update minimum dependency to Markdown 3.2.1.
- Updated minimum dependency to Jinja 2.10.1 to address security concerns (#1780).
- Update to lunr.js 2.3.8 (#1989).
- Add support for Python 3.8.
- Drop support for Python 3.4.
- Drop support for Python 2.7. MkDocs is PY3 only now (#1926).
- Bugfix: Select appropriate asyncio event loop on Windows for Python 3.8+ (#1885).
- Bugfix: Ensure nested index pages do not get identified as the homepage (#1919).
- Bugfix: Properly identify deployment version (#1879).
- Bugfix: Properly build
ValidationError
message forcustom_dir
(#1849). - Bugfix: Exclude Markdown files and READMEs from theme (#1766).
- Bugfix: Account for encoded URLs (#1670).
- Bugfix: Ensure theme files do not override
docs_dir
files (#1671). - Bugfix: Do not normalize URL fragments (#1655).
- Bugfix: Skip external URLs in sitemap.xml (#1742).
- Bugfix: Ensure theme files do not override docs_dir files on Windows (#1876)
- Add canonical tag to
readthedocs
theme (#1669). - Improved error message for when
git
is not available. - Add support for
nav_style
theme option for themkdocs
theme (#1930). - Bugfix: Long/nested dropdowns now behave more consistently for the
mkdocs
theme (#1234). - Bugfix: Multi-row nav headers in the
mkdocs
theme no longer obscure the document content (#716). - Add support for
navigation_depth
theme option for themkdocs
theme (#1970). level
attribute inpage.toc
items is now 1-indexed to match the level in<hN>
tags (#1970).
Version 1.0.4 (2018-09-07)
- Bugfix: Ignore absolute links in Markdown (#1621).
Version 1.0.3 (2018-08-29)
- Bugfix: Warn on relative paths in navigation (#1604).
- Bugfix: Handle empty
theme_config.yml
files correctly (#1602).
Version 1.0.2 (2018-08-22)
- Bugfix: Provide absolute
base_url
to error templates (#1598).
Version 1.0.1 (2018-08-13)
- Bugfix: Prevent page reload when [Enter] is pressed in search box (#1589).
- Bugfix: Avoid calling
search
until all assets are ready (#1584). - Bugfix: Exclude
README.md
ifindex.md
is present (#1580). - Bugfix: Fix
readthedocs
theme navigation bug with homepage (#1576).
Version 1.0 (2018-08-03)
Major Additions to Version 1.0
Internal Refactor of Pages, Files, and Navigation
Internal handling of pages, files and navigation has been completely refactored. The changes included in the refactor are summarized below.
- Support for hidden pages. All Markdown pages are now included in the build regardless of whether they are included in the navigation configuration (#699).
- The navigation can now include links to external sites (#989 #1373 & #1406).
- Page data (including titles) is properly determined for all pages before any page is rendered (#1347).
- Automatically populated navigation now sorts index pages to the top. In other words, The index page will be listed as the first child of a directory, while all other documents are sorted alphanumerically by file name after the index page (#73 & #1042).
- A
README.md
file is now treated as an index file within a directory and will be rendered toindex.html
(#608). - The URLs for all files are computed once and stored in a files collection. This ensures all internal links are always computed correctly regardless of the configuration. This also allows all internal links to be validated, not just links to other Markdown pages. (#842 & #872).
- A new url template filter smartly ensures all URLs are relative to the current page (#1526).
- An on_files plugin event has been added, which could be used to include
files not in the
docs_dir
, exclude files, redefine page URLs (i.e. implement extensionless URLs), or to manipulate files in various other ways.
Backward Incompatible Changes
As part of the internal refactor, a number of backward incompatible changes have been introduced, which are summarized below.
URLs have changed when use_directory_urls
is False
Previously, all Markdown pages would be have their filenames altered to be index
pages regardless of how the use_directory_urls setting was configured.
However, the path munging is only needed when use_directory_urls
is set to
True
(the default). The path mangling no longer happens when
use_directory_urls
is set to False
, which will result in different URLs for
all pages that were not already index files. As this behavior only effects a
non-default configuration, and the most common user-case for setting the option
to False
is for local file system (file://
) browsing, its not likely to
effect most users. However, if you have use_directory_urls
set to False
for a MkDocs site hosted on a web server, most of your URLs will now be broken.
As you can see below, the new URLs are much more sensible.
| Markdown file | Old URL | New URL |
|---|---|---|
index.md |
index.html |
index.html |
foo.md |
foo/index.html |
foo.html |
foo/bar.md |
foo/bar/index.html |
foo/bar.html |
Note that there has been no change to URLs or file paths when
use_directory_urls
is set to True
(the default), except that MkDocs more
consistently includes an ending slash on all internally generated URLs.
The pages
configuration setting has been renamed to nav
The pages
configuration setting is deprecated and will issue a warning if set
in the configuration file. The setting has been renamed nav
. To update your
configuration, simply rename the setting to nav
. In other words, if your
configuration looked like this:
pages:
- Home: index.md
- User Guide: user-guide.md
Simply edit the configuration as follows:
nav:
- Home: index.md
- User Guide: user-guide.md
In the current release, any configuration which includes a pages
setting, but
no nav
setting, the pages
configuration will be copied to nav
and a
warning will be issued. However, in a future release, that may no longer happen.
If both pages
and nav
are defined, the pages
setting will be ignored.
Template variables and base_url
In previous versions of MkDocs some URLs expected the base_url template variable to be prepended to the URL and others did not. That inconsistency has been removed in that no URLs are modified before being added to the template context.
For example, a theme template might have previously included a link to
the site_name
as:
{{ config.site_name }}
And MkDocs would magically return a URL for the homepage which was relative to the current page. That “magic” has been removed and the url template filter should be used:
{{ config.site_name }}
This change applies to any navigation items and pages, as well as the
page.next_page
and page.previous_page
attributes. For the time being, the
extra_javascript
and extra_css
variables continue to work as previously
(without the url
template filter), but they have been deprecated and the
corresponding configuration values (config.extra_javascript
and
config.extra_css
respectively) should be used with the filter instead.
{% for path in config['extra_css'] %}
<link href="{{ path|url }}" rel="stylesheet">
{% endfor %}
Note that navigation can now include links to external sites. Obviously, the
base_url
should not be prepended to these items. However, the url
template
filter is smart enough to recognize the URL is absolute and does not alter it.
Therefore, all navigation items can be passed to the filter and only those that
need to will be altered.
{% for nav_item in nav %}
{{ nav_item.title }}
{% endfor %}
Path Based Settings are Relative to Configuration File (#543)
Previously any relative paths in the various configuration options were resolved relative to the current working directory. They are now resolved relative to the configuration file. As the documentation has always encouraged running the various MkDocs commands from the directory that contains the configuration file (project root), this change will not affect most users. However, it will make it much easier to implement automated builds or otherwise run commands from a location other than the project root.
Simply use the -f/--config-file
option and point it at the configuration file:
mkdocs build --config-file /path/to/my/config/file.yml
As previously, if no file is specified, MkDocs looks for a file named
mkdocs.yml
in the current working directory.
Added support for YAML Meta-Data (#1542)
Previously, MkDocs only supported MultiMarkdown style meta-data, which does not
recognize different data types and is rather limited. MkDocs now also supports
YAML style meta-data in Markdown documents. MkDocs relies on the the presence or
absence of the deliminators (---
or ...
) to determine whether YAML style
meta-data or MultiMarkdown style meta-data is being used.
Previously MkDocs would recognize MultiMarkdown style meta-data between the deliminators. Now, if the deliminators are detected, but the content between the deliminators is not valid YAML meta-data, MkDocs does not attempt to parse the content as MultiMarkdown style meta-data. Therefore, MultiMarkdown’s style meta-data must not include the deliminators. See the MultiMarkdown style meta-data documentation for details.
Prior to version 0.17, MkDocs returned all meta-data values as a list of strings (even a single line would return a list of one string). In version 0.17, that behavior was changed to return each value as a single string (multiple lines were joined), which some users found limiting (see #1471). That behavior continues for MultiMarkdown style meta-data in the current version. However, YAML style meta-data supports the full range of “safe” YAML data types. Therefore, it is recommended that any complex meta-data make use of the YAML style (see the YAML style meta-data documentation for details). In fact, a future version of MkDocs may deprecate support for MultiMarkdown style meta-data.
Refactor Search Plugin
The search plugin has been completely refactored to include support for the following features:
- Use a web worker in the browser with a fallback (#1396).
- Optionally pre-build search index locally (#859 & #1061).
- Upgrade to lunr.js 2.x (#1319).
- Support search in languages other than English (#826).
- Allow the user to define the word separators (#867).
- Only run searches for queries of length > 2 (#1127).
- Remove dependency on require.js (#1218).
- Compress the search index (#1128).
Users can review the configuration options available and theme authors should review how search and themes interact.
theme_dir
Configuration Option fully Deprecated
As of version 0.17, the custom_dir option replaced the deprecated theme_dir
option. If users had set the theme_dir
option, MkDocs version 0.17 copied the
value to the theme.custom_dir
option and a warning was issued. As of version
1.0, the value is no longer copied and an error is raised.
Other Changes and Additions to Version 1.0
- Keyboard shortcuts changed to not conflict with commonly used accessibility shortcuts (#1502.)
- User friendly YAML parse errors (#1543).
- Officially support Python 3.7.
- A missing theme configuration file now raises an error.
- Empty
extra_css
andextra_javascript
settings no longer raise a warning. - Add highlight.js configuration settings to built-in themes (#1284).
- Close search modal when result is selected (#1527).
- Add a level attribute to AnchorLinks (#1272).
- Add MkDocs version check to gh-deploy script (#640).
- Improve Markdown extension error messages. (#782).
- Drop official support for Python 3.3 and set
tornado>=5.0
(#1427). - Add support for GitLab edit links (#1435).
- Link to GitHub issues from release notes (#644).
- Expand {sha} and {version} in gh-deploy commit message (#1410).
- Compress
sitemap.xml
(#1130). - Defer loading JS scripts (#1380).
- Add a title attribute to the search input (#1379).
- Update RespondJS to latest version (#1398).
- Always load Google Analytics over HTTPS (#1397).
- Improve scrolling frame rate (#1394).
- Provide more version info. (#1393).
- Refactor
writing-your-docs.md
(#1392). - Workaround Safari bug when zooming to < 100% (#1389).
- Remove addition of
clicky
class to body and animations. (#1387). - Prevent search plugin from re-injecting
extra_javascript
files (#1388). - Refactor
copy_media_files
util function for more flexibility (#1370). - Remove PyPI Deployment Docs (#1360).
- Update links to Python-Markdown library (#1360).
- Document how to generate manpages for MkDocs commands (#686).
Version 0.17.5 (2018-07-06)
- Bugfix: Fix Python 3.7 and PEP 479 incompatibility (#1518).
Version 0.17.4 (2018-06-08)
- Bugfix: Add multi-level nesting support to sitemap.xml (#1482).
Version 0.17.3 (2018-03-07)
- Bugfix: Set dependency
tornado>=4.1,<5.0
due to changes in 5.0 (#1428).
Version 0.17.2 (2017-11-15)
- Bugfix: Correct
extra_*
config setting regressions (#1335 & #1336).
Version 0.17.1 (2017-10-30)
- Bugfix: Support
repo_url
with missing ending slash. (#1321). - Bugfix: Add length support to
mkdocs.toc.TableOfContext
(#1325). - Bugfix: Add some theme specific settings to the search plugin for third party themes (#1316).
- Bugfix: Override
site_url
withdev_addr
on local server (#1317).
Version 0.17.0 (2017-10-19)
Major Additions to Version 0.17.0
Plugin API. (#206)
A new Plugin API has been added to MkDocs which allows users to define their own custom behaviors. See the included documentation for a full explanation of the API.
The previously built-in search functionality has been removed and wrapped in a
plugin (named “search”) with no changes in behavior. When MkDocs builds, the
search index is now written to search/search_index.json
instead of
mkdocs/search_index.json
. If no plugins setting is defined in the config,
then the search
plugin will be included by default. See the
configuration documentation for information on overriding the
default.
Theme Customization. (#1164)
Support had been added to provide theme specific customizations. Theme authors
can define default options as documented in Theme Configuration. A theme can
now inherit from another theme, define various static templates to be rendered,
and define arbitrary default variables to control behavior in the templates.
The theme configuration is defined in a configuration file named
mkdocs_theme.yml
which should be placed at the root of your template files. A
warning will be raised if no configuration file is found and an error will be
raised in a future release.
Users can override those defaults under the theme configuration option of
their mkdocs.yml
configuration file, which now accepts nested options. One
such nested option is the custom_dir option, which replaces the now deprecated
theme_dir
option. If users had previously set the theme_dir
option, a
warning will be issued, with an error expected in a future release.
If a configuration previously defined a theme_dir
like this:
theme: mkdocs
theme_dir: custom
Then the configuration should be adjusted as follows:
theme:
name: mkdocs
custom_dir: custom
See the theme configuration option documentation for details.
Previously deprecated Template variables removed. (#1168)
Page Template
The primary entry point for page templates has been changed from base.html
to
main.html
. This allows base.html
to continue to exist while allowing users
to override main.html
and extend base.html
. For version 0.16, base.html
continued to work if no main.html
template existed, but it raised a
deprecation warning. In version 1.0, a build will fail if no main.html
template exists.
Context Variables
Page specific variable names in the template context have been refactored as defined in Custom Themes. The old variable names issued a warning in version 0.16, but have been removed in version 1.0.
Any of the following old page variables should be updated to the new ones in user created and third-party templates:
| Old Variable Name | New Variable Name |
|---|---|
| current_page | page |
| page_title | page.title |
| content | page.content |
| toc | page.toc |
| meta | page.meta |
| canonical_url | page.canonical_url |
| previous_page | page.previous_page |
| next_page | page.next_page |
Additionally, a number of global variables have been altered and/or removed and user created and third-party templates should be updated as outlined below:
| Old Variable Name | New Variable Name or Expression |
|---|---|
| current_page | page |
| include_nav | nav|length>1 |
| include_next_prev | (page.next_page or page.previous_page) |
| site_name | config.site_name |
| site_author | config.site_author |
| page_description | config.site_description |
| repo_url | config.repo_url |
| repo_name | config.repo_name |
| site_url | config.site_url |
| copyright | config.copyright |
| google_analytics | config.google_analytics |
| homepage_url | nav.homepage.url |
| favicon | {{ base_url }}/img/favicon.ico |
Auto-Populated extra_css and extra_javascript Fully Deprecated. (#986)
In previous versions of MkDocs, if the extra_css
or extra_javascript
config
settings were empty, MkDocs would scan the docs_dir
and auto-populate each
setting with all of the CSS and JavaScript files found. On version 0.16 this
behavior was deprecated and a warning was issued. In 0.17 any unlisted CSS and
JavaScript files will not be included in the HTML templates, however, a warning
will be issued. In other words, they will still be copied to the site-dir
, but
they will not have any effect on the theme if they are not explicitly listed.
All CSS and JavaScript files in the docs_dir
should be explicitly listed in
the extra_css
or extra_javascript
config settings going forward.
Other Changes and Additions to Version 0.17.0
- Add “edit Link” support to MkDocs theme (#1129)
- Open files with
utf-8-sig
to account for BOM (#1186) - Symbolic links are now followed consistently (#1134)
- Support for keyboard navigation shortcuts added to included themes (#1095)
- Some refactoring and improvements to config_options (#1296)
- Officially added support for Python 3.6 (#1296)
- 404 Error page added to readthedocs theme (#1296))
- Internal refactor of Markdown processing (#713)
- Removed special error message for mkdocs-bootstrap and mkdocs-bootswatch themes (#1168)
- The legacy pages config is no longer supported (#1168)
- The deprecated
json
command has been removed (#481) - Support for Python 2.6 has been dropped (#165)
- File permissions are no longer copied during build (#1292)
- Support query and fragment strings in
edit_uri
(#1224 & #1273)
Version 0.16.3 (2017-04-04)
- Fix error raised by autoscrolling in the readthedocs theme (#1177)
- Fix a few documentation typos (#1181 & #1185)
- Fix a regression to livereload server introduced in 0.16.2 (#1174)
Version 0.16.2 (2017-03-13)
- System root (
/
) is not a valid path for site_dir or docs_dir (#1161) - Refactor readthedocs theme navigation (#1155 & #1156)
- Add support to dev server to serve custom error pages (#1040)
- Ensure nav.homepage.url is not blank on error pages (#1131)
- Increase livereload dependency to 2.5.1 (#1106)
Version 0.16.1 (2016-12-22)
- Ensure scrollspy behavior does not affect nav bar (#1094)
- Only “load” a theme when it is explicitly requested by the user (#1105)
Version 0.16 (2016-11-04)
Major Additions to Version 0.16.0
Template variables refactored. (#874)
Page Context
Page specific variable names in the template context have been refactored as defined in Custom Themes. The old variable names will issue a warning but continue to work for version 0.16, but may be removed in a future version.
Any of the following old page variables should be updated to the new ones in user created and third-party templates:
| Old Variable Name | New Variable Name |
|---|---|
| current_page | page |
| page_title | page.title |
| content | page.content |
| toc | page.toc |
| meta | page.meta |
| canonical_url | page.canonical_url |
| previous_page | page.previous_page |
| next_page | page.next_page |
Global Context
Additionally, a number of global variables have been altered and/or deprecated and user created and third-party templates should be updated as outlined below:
Previously, the global variable include_nav
was altered programmatically based
on the number of pages in the nav. The variable will issue a warning but
continue to work for version 0.16, but may be removed in a future version. Use
{% if nav|length>1 %}
instead.
Previously, the global variable include_next_prev
was altered programmatically
based on the number of pages in the nav. The variable will issue a warning but
continue to work for version 0.16, but may be removed in a future version. Use
{% if page.next_page or page.previous_page %}
instead.
Previously the global variable page_description
was altered programmatically
based on whether the current page was the homepage. Now it simply maps to
config['site_description']
. Use {% if page.is_homepage %}
in the template to
conditionally change the description.
The global variable homepage_url
maps directly to nav.homepage.url
and is
being deprecated. The variable will issue a warning but continue to work for
version 0.16, but may be removed in a future version. Use nav.homepage.url
instead.
The global variable favicon
maps to the configuration setting site_favicon
.
Both the template variable and the configuration setting are being deprecated
and will issue a warning but continue to work for version 0.16, and may be
removed in a future version. Use {{ base_url }}/img/favicon.ico
in your
template instead. Users can simply save a copy of their custom favicon icon to
img/favicon.ico
in either their docs_dir
or theme_dir
.
A number of variables map directly to similarly named variables in the config
.
Those variables are being deprecated and will issue a warning but continue to
work for version 0.16, but may be removed in a future version. Use
config.var_name
instead, where var_name
is the name of one of the
configuration variables.
Below is a summary of all of the changes made to the global context:
| Old Variable Name | New Variable Name or Expression |
|---|---|
| current_page | page |
| include_nav | nav|length>1 |
| include_next_prev | (page.next_page or page.previous_page) |
| site_name | config.site_name |
| site_author | config.site_author |
| page_description | config.site_description |
| repo_url | config.repo_url |
| repo_name | config.repo_name |
| site_url | config.site_url |
| copyright | config.copyright |
| google_analytics | config.google_analytics |
| homepage_url | nav.homepage.url |
| favicon | {{ base_url }}/img/favicon.ico |
Increased Template Customization. (#607)
The built-in themes have been updated by having each of their many parts wrapped
in template blocks which allow each individual block to be easily overridden
using the theme_dir
config setting. Without any new settings, you can use a
different analytics service, replace the default search function, or alter the
behavior of the navigation, among other things. See the relevant
documentation for more details.
To enable this feature, the primary entry point for page templates has been
changed from base.html
to main.html
. This allows base.html
to continue to
exist while allowing users to override main.html
and extend base.html
. For
version 0.16, base.html
will continue to work if no main.html
template
exists, but it is deprecated and will raise a warning. In version 1.0, a build
will fail if no main.html
template exists. Any custom and third party
templates should be updated accordingly.
The easiest way for a third party theme to be updated would be to simply add a
main.html
file which only contains the following line:
{% extends "base.html" %}
That way, the theme contains the main.html
entry point, and also supports
overriding blocks in the same manner as the built-in themes. Third party themes
are encouraged to wrap the various pieces of their templates in blocks in order
to support such customization.
Auto-Populated extra_css
and extra_javascript
Deprecated. (#986)
In previous versions of MkDocs, if the extra_css
or extra_javascript
config
settings were empty, MkDocs would scan the docs_dir
and auto-populate each
setting with all of the CSS and JavaScript files found. This behavior is
deprecated and a warning will be issued. In the next release, the auto-populate
feature will stop working and any unlisted CSS and JavaScript files will not be
included in the HTML templates. In other words, they will still be copied to the
site-dir
, but they will not have any effect on the theme if they are not
explicitly listed.
All CSS and JavaScript files in the docs_dir
should be explicitly listed in
the extra_css
or extra_javascript
config settings going forward.
Support for dirty builds. (#990)
For large sites the build time required to create the pages can become problematic,
thus a “dirty” build mode was created. This mode simply compares the modified time
of the generated HTML and source markdown. If the markdown has changed since the
HTML then the page is re-constructed. Otherwise, the page remains as is. This mode
may be invoked in both the mkdocs serve
and mkdocs build
commands:
mkdocs serve --dirtyreload
mkdocs build --dirty
It is important to note that this method for building the pages is for development of content only, since the navigation and other links do not get updated on other pages.
Stricter Directory Validation
Previously, a warning was issued if the site_dir
was a child directory of the
docs_dir
. This now raises an error. Additionally, an error is now raised if
the docs_dir
is set to the directory which contains your config file rather
than a child directory. You will need to rearrange you directory structure to
better conform with the documented layout.
Other Changes and Additions to Version 0.16.0
- Bugfix: Support
gh-deploy
command on Windows with Python 3 (#722) - Bugfix: Include .woff2 font files in Python package build (#894)
- Various updates and improvements to Documentation Home Page/Tutorial (#870)
- Bugfix: Support livereload for config file changes (#735)
- Bugfix: Non-media template files are no longer copied with media files (#807)
- Add a flag (-e/–theme-dir) to specify theme directory with the commands
mkdocs build
andmkdocs serve
(#832) - Fixed issues with Unicode file names under Windows and Python 2. (#833)
- Improved the styling of in-line code in the MkDocs theme. (#718)
- Bugfix: convert variables to JSON when being passed to JavaScript (#850)
- Updated the ReadTheDocs theme to match the upstream font sizes and colors more closely. (#857)
- Fixes an issue with permalink markers showing when the mouse was far above them (#843)
- Bugfix: Handle periods in directory name when automatically creating the pages config. (#728)
- Update searching to Lunr 0.7, which comes with some performance enhancements for larger documents (#859)
- Bugfix: Support SOURCE_DATE_EPOCH environment variable for “reproducible” builds (#938)
- Follow links when copying media files (#869).
- Change “Edit on…” links to point directly to the file in the source
repository, rather than to the root of the repository (#975), configurable
via the new
edit_uri
setting. - Bugfix: Don’t override config value for strict mode if not specified on CLI (#738).
- Add a
--force
flag to thegh-deploy
command to force the push to the repository (#973). - Improve alignment for current selected menu item in readthedocs theme (#888).
http://user.github.io/repo
=>https://user.github.io/repo/
(#1029).- Improve installation instructions (#1028).
- Account for wide tables and consistently wrap inline code spans (#834).
- Bugfix: Use absolute URLs in nav & media links from error templates (#77).
Version 0.15.3 (2016-02-18)
- Improve the error message the given theme can’t be found.
- Fix an issue with relative symlinks (#639)
Version 0.15.2 (2016-02-08)
- Fix an incorrect warning that states external themes will be removed from MkDocs.
Version 0.15.1 (2016-01-30)
- Lower the minimum supported Click version to 3.3 for package maintainers. (#763)
Version 0.15.0 (2016-01-21)
Major Additions to Version 0.15.0
Add support for installable themes
MkDocs now supports themes that are distributed via Python packages. With this addition, the Bootstrap and Bootswatch themes have been moved to external git repositories and python packages. See their individual documentation for more details about these specific themes.
They will be included with MkDocs by default until a future release. After that
they will be installable with pip: pip install mkdocs-bootstrap
and pip
install mkdocs-bootswatch
See the documentation for Customizing Your Theme for more information about using and customizing themes and Custom themes for creating and distributing new themes
Other Changes and Additions to Version 0.15.0
- Fix issues when using absolute links to Markdown files. (#628)
- Deprecate support of Python 2.6, pending removal in 1.0.0. (#165)
- Add official support for Python version 3.5.
- Add support for site_description and site_author to the ReadTheDocs theme. (#631)
- Update FontAwesome to 4.5.0. (#789)
- Increase IE support with X-UA-Compatible. (#785)
- Added support for Python’s
-m
flag. (#706) - Bugfix: Ensure consistent ordering of auto-populated pages. (#638)
- Bugfix: Scroll the tables of contents on the MkDocs theme if it is too long for the page. (#204)
- Bugfix: Add all ancestors to the page attribute
ancestors
rather than just the initial one. (#693) - Bugfix: Include HTML in the build output again. (#691)
- Bugfix: Provide filename to Read the Docs. (#721 and RTD#1480)
- Bugfix: Silence Click’s unicode_literals warning. (#708)
Version 0.14.0 (2015-06-09)
- Improve Unicode handling by ensuring that all config strings are loaded as Unicode. (#592)
- Remove dependency on the six library. (#583)
- Remove dependency on the ghp-import library. (#547)
- Add
--quiet
and--verbose
options to all sub-commands. (#579) - Add short options (
-a
) to most command line options. (#579) - Add copyright footer for readthedocs theme. (#568)
- If the requested port in
mkdocs serve
is already in use, don’t show the user a full stack trace. (#596) - Bugfix: Fix a JavaScript encoding problem when searching with spaces. (#586)
- Bugfix: gh-deploy now works if the mkdocs.yml is not in the git repo root. (#578)
- Bugfix: Handle (pass-through instead of dropping) HTML entities while parsing TOC. (#612)
- Bugfix: Default extra_templates to an empty list, don’t automatically discover them. (#616)
Version 0.13.3 (2015-06-02)
- Bugfix: Reduce validation error to a warning if the site_dir is within the docs_dir as this shouldn’t cause any problems with building but will inconvenience users building multiple times. (#580)
Version 0.13.2 (2015-05-30)
- Bugfix: Ensure all errors and warnings are logged before exiting. (#536)
- Bugfix: Fix compatibility issues with ReadTheDocs. (#554)
Version 0.13.1 (2015-05-27)
- Bugfix: Fix a problem with minimal configurations which only contain a list of paths in the pages config. (#562)
Version 0.13.0 (2015-05-26)
Deprecations to Version 0.13.0
Deprecate the JSON command
In this release the mkdocs json
command has been marked as deprecated and
when used a deprecation warning will be shown. It will be removed in a future
release of MkDocs, version 1.0 at the latest. The mkdocs json
command
provided a convenient way for users to output the documentation contents as
JSON files but with the additions of search to MkDocs this functionality is
duplicated.
A new index with all the contents from a MkDocs build is created in the
site_dir, so with the default value for the site_dir
It can be found in
site/mkdocs/search_index.json
.
This new file is created on every MkDocs build (with mkdocs build
) and
no configuration is needed to enable it.
Change the pages configuration
Provide a new way to define pages, and specifically nested pages, in the mkdocs.yml file and deprecate the existing approach, support will be removed with MkDocs 1.0.
Warn users about the removal of builtin themes
All themes other than mkdocs and readthedocs will be moved into external packages in a future release of MkDocs. This will enable them to be more easily supported and updates outside MkDocs releases.
Major Additions to Version 0.13.0
Search
Support for search has now been added to MkDocs. This is based on the
JavaScript library lunr.js. It has been added to both the mkdocs
and
readthedocs
themes. See the custom theme documentation on supporting search
for adding it to your own themes.
New Command Line Interface
The command line interface for MkDocs has been re-written with the Python library Click. This means that MkDocs now has an easier to use interface with better help output.
This change is partially backwards incompatible as while undocumented it was
possible to pass any configuration option to the different commands. Now only
a small subset of the configuration options can be passed to the commands. To
see in full commands and available arguments use mkdocs --help
and
mkdocs build --help
to have them displayed.
Support Extra HTML and XML files
Like the extra_javascript and extra_css configuration options, a new
option named extra_templates has been added. This will automatically be
populated with any .html
or .xml
files in the project docs directory.
Users can place static HTML and XML files and they will be copied over, or they can also use Jinja2 syntax and take advantage of the global variables.
By default MkDocs will use this approach to create a sitemap for the documentation.
Other Changes and Additions to Version 0.13.0
- Add support for Markdown extension configuration options. (#435)
- MkDocs now ships Python wheels. (#486)
- Only include the build date and MkDocs version on the homepage. (#490)
- Generate sitemaps for documentation builds. (#436)
- Add a clearer way to define nested pages in the configuration. (#482)
- Add an extra config option for passing arbitrary variables to the template. (#510)
- Add
--no-livereload
tomkdocs serve
for a simpler development server. (#511) - Add copyright display support to all themes (#549)
- Add support for custom commit messages in a
mkdocs gh-deploy
(#516) - Bugfix: Fix linking to media within the same directory as a markdown file called index.md (#535)
- Bugfix: Fix errors with Unicode filenames (#542).
Version 0.12.2 (2015-04-22)
- Bugfix: Fix a regression where there would be an error if some child titles were missing but others were provided in the pages config. (#464)
Version 0.12.1 (2015-04-14)
- Bugfix: Fixed a CSS bug in the table of contents on some browsers where the bottom item was not clickable.
Version 0.12.0 (2015-04-14)
- Display the current MkDocs version in the CLI output. (#258)
- Check for CNAME file when using gh-deploy. (#285)
- Add the homepage back to the navigation on all themes. (#271)
- Add a strict more for local link checking. (#279)
- Add Google analytics support to all themes. (#333)
- Add build date and MkDocs version to the ReadTheDocs and MkDocs theme outputs. (#382)
- Standardize highlighting across all themes and add missing languages. (#387)
- Add a verbose flag. (-v) to show more details about what the build. (#147)
- Add the option to specify a remote branch when deploying to GitHub. This enables deploying to GitHub pages on personal and repo sites. (#354)
- Add favicon support to the ReadTheDocs theme HTML. (#422)
- Automatically refresh the browser when files are edited. (#163)
- Bugfix: Never re-write URLs in code blocks. (#240)
- Bugfix: Don’t copy dotfiles when copying media from the
docs_dir
. (#254) - Bugfix: Fix the rendering of tables in the ReadTheDocs theme. (#106)
- Bugfix: Add padding to the bottom of all bootstrap themes. (#255)
- Bugfix: Fix issues with nested Markdown pages and the automatic pages configuration. (#276)
- Bugfix: Fix a URL parsing error with GitHub enterprise. (#284)
- Bugfix: Don’t error if the mkdocs.yml is completely empty. (#288)
- Bugfix: Fix a number of problems with relative URLs and Markdown files. (#292)
- Bugfix: Don’t stop the build if a page can’t be found, continue with other pages. (#150)
- Bugfix: Remove the site_name from the page title, this needs to be added manually. (#299)
- Bugfix: Fix an issue with table of contents cutting off Markdown. (#294)
- Bugfix: Fix hostname for BitBucket. (#339)
- Bugfix: Ensure all links end with a slash. (#344)
- Bugfix: Fix repo links in the readthedocs theme. (#365)
- Bugfix: Include jQuery locally to avoid problems using MkDocs offline. (#143)
- Bugfix: Don’t allow the docs_dir to be in the site_dir or vice versa. (#384)
- Bugfix: Remove inline CSS in the ReadTheDocs theme. (#393)
- Bugfix: Fix problems with the child titles due to the order the pages config was processed. (#395)
- Bugfix: Don’t error during live reload when the theme doesn’t exist. (#373)
- Bugfix: Fix problems with the Meta extension when it may not exist. (#398)
- Bugfix: Wrap long inline code otherwise they will run off the screen. (#313)
- Bugfix: Remove HTML parsing regular expressions and parse with HTMLParser to fix problems with titles containing code. (#367)
- Bugfix: Fix an issue with the scroll to anchor causing the title to be hidden under the navigation. (#7)
- Bugfix: Add nicer CSS classes to the HTML tables in bootswatch themes. (#295)
- Bugfix: Fix an error when passing in a specific config file with
mkdocs serve
. (#341) - Bugfix: Don’t overwrite index.md files with the
mkdocs new
command. (#412) - Bugfix: Remove bold and italic from code in the ReadTheDocs theme. (#411)
- Bugfix: Display images inline in the MkDocs theme. (#415)
- Bugfix: Fix problems with no-highlight in the ReadTheDocs theme. (#319)
- Bugfix: Don’t delete hidden files when using
mkdocs build --clean
. (#346) - Bugfix: Don’t block newer versions of Python-markdown on Python >= 2.7. (#376)
- Bugfix: Fix encoding issues when opening files across platforms. (#428)
Version 0.11.1 (2014-11-20)
- Bugfix: Fix a CSS wrapping issue with code highlighting in the ReadTheDocs theme. (#233)
Version 0.11.0 (2014-11-18)
- Render 404.html files if they exist for the current theme. (#194)
- Bugfix: Fix long nav bars, table rendering and code highlighting in MkDocs and ReadTheDocs themes. (#225)
- Bugfix: Fix an issue with the google_analytics code. (#219)
- Bugfix: Remove
__pycache__
from the package tar. (#196) - Bugfix: Fix markdown links that go to an anchor on the current page. (#197)
- Bugfix: Don’t add
prettyprint well
CSS classes to all HTML, only add it in the MkDocs theme. (#183) - Bugfix: Display section titles in the ReadTheDocs theme. (#175)
- Bugfix: Use the polling observer in watchdog so rebuilding works on filesystems without inotify. (#184)
- Bugfix: Improve error output for common configuration related errors. (#176)
Version 0.10.0 (2014-10-29)
- Added support for Python 3.3 and 3.4. (#103)
- Configurable Python-Markdown extensions with the config setting
markdown_extensions
. (#74) - Added
mkdocs json
command to output your rendered documentation as json files. (#128) - Added
--clean
switch tobuild
,json
andgh-deploy
commands to remove stale files from the output directory. (#157) - Support multiple theme directories to allow replacement of individual templates rather than copying the full theme. (#129)
- Bugfix: Fix

rendering in readthedocs theme. (#171) - Bugfix: Improve the readthedocs theme on smaller displays. (#168)
- Bugfix: Relaxed required python package versions to avoid clashes. (#104)
- Bugfix: Fix issue rendering the table of contents with some configs. (#146)
- Bugfix: Fix path for embedded images in sub pages. (#138)
- Bugfix: Fix
use_directory_urls
config behavior. (#63) - Bugfix: Support
extra_javascript
andextra_css
in all themes. (#90) - Bugfix: Fix path-handling under Windows. (#121)
- Bugfix: Fix the menu generation in the readthedocs theme. (#110)
- Bugfix: Fix the mkdocs command creation under Windows. (#122)
- Bugfix: Correctly handle external
extra_javascript
andextra_css
. (#92) - Bugfix: Fixed favicon support. (#87)


Properties summary
protected static
string
|
$defaultPathConstraint
Default constraint used for all rewrite params in request path, if no
constraint for that param has been specified in route instance.
Default value is "[^/]+" , what means "any character(s) except slash,
one or more character(s) long."
Default constraint used for all rewrite params in request path, if no
constraint for that param has been specified in route instance.
Default value is "[^/]+" , what means "any character(s) except slash,
one or more character(s) long."
|
|
protected static
string
|
$defaultDomainConstraint
Default constraint used for all rewrite params in domain pattern part, if
no constraint for that param has been specified in route instance.
Default value is "[^\.]+" , what means "any character(s) except dot,
one or more character(s) long."
Default constraint used for all rewrite params in domain pattern part, if
no constraint for that param has been specified in route instance.
Default value is "[^\.]+" , what means "any character(s) except dot,
one or more character(s) long."
|
|
protected static
array
|
$protectedProperties
Properties names with request specific values to not serialize in cache.
Properties names with request specific values to not serialize in cache.
|
#
[
'router' => 1, 'matchedParams' => 1,
]
|
protected
string|string[]|null
|
$pattern
Route base pattern to complete match pattern string to match requested
URL and to complete reverse pattern string to build back an URL address.
Route base pattern to complete match pattern string to match requested
URL and to complete reverse pattern string to build back an URL address.
To define route by this form is the most comfortable way, but a way
slower, because there is necessary every request to convert this value
into match and into reverse properties correctly. But you can specify
those both properties directly, if you can write regular expressions.
This match and reverse definition has to be in very basic form without
regular expression escaping or advanced rules:
- No regular expression border # characters, it's used in match only.
- No start ^ or end $ regular expression chars, also used in match .
- No escaping of regular expression characters: [](){}<>|=+*.!?-/ , those characters will be escaped in route match property.
- Star character inside param name (<color*> ) means greedy param matching all to the end of the URL address. It has to be the last one.
Example: "/products-list/<name>[/<color*>]" .
|
|
protected
string|string[]|null
|
$match
Route match pattern in raw form (to use it as it is) to match requested
URL. This match pattern must have the very same structure and content
as reverse pattern, because there is necessary to complete route flags
from reverse pattern string - to prepare proper regular expression
subject for this match , not just only the request path . Because those
flags is not possible to detect from raw regular expression string.
Route match pattern in raw form (to use it as it is) to match requested
URL. This match pattern must have the very same structure and content
as reverse pattern, because there is necessary to complete route flags
from reverse pattern string - to prepare proper regular expression
subject for this match , not just only the request path . Because those
flags is not possible to detect from raw regular expression string.
This is required together with route reverse property, if you have not
configured route pattern property instead.
To define the route by assigning properties route match and route
reverse together is little bit more annoying way to define it (because
you have to write almost the same information twice), but it's the best
speed solution, because there is no route internal metadata completion
and pattern parsing into match and reverse properties.
Example: "#^/products\-list/(?<name>[^/]+)(/(?<id>\d+))?/?$#"
|
|
protected
string|string[]|null
|
$reverse
Route reverse address replacements pattern to build url.
- No regular expression border # characters.
- No regular expression characters escaping ([](){}<>|=+*.!?-/ ).
- No start ^ or end $ regular expression characters.
Route reverse address replacements pattern to build url.
- No regular expression border # characters.
- No regular expression characters escaping ([](){}<>|=+*.!?-/ ).
- No start ^ or end $ regular expression characters.
Required together with route match property, if you have not configured
route pattern property instead. This is only very simple string with
variable section definitions defined by brackets [] and with parameters
replacement places (like <name> or <page> ) for given values by
\MvcCore\Router::Url($name, $params); method.
To define the route by assigning properties route match and route
reverse together is little bit more annoying way to define it (because
you have to write almost the same information twice), but it's the best
speed solution, because there is no route internal metadata completion
and pattern parsing into match and reverse properties.
Example: "/products-list/<name>[/<color>]"
|
|
protected
string
|
$name
Not required. Route name is your custom keyword/term or pascal case
combination of controller and action describing "Controller:Action"
target to be dispatched.
Not required. Route name is your custom keyword/term or pascal case
combination of controller and action describing "Controller:Action"
target to be dispatched.
By this name there is selected proper route object to complete URL string
by given params in router method: \MvcCore\Router:Url($name, $params); .
Example: "products_list" | "Products:Gallery"
|
|
protected
string
|
$controller
Controller name/path to dispatch, in pascal case. This property is not
required. If there is controller param inside route pattern or inside
route match pattern property, it's used to define this record to dispatch
specific requested controller.
Controller name/path to dispatch, in pascal case. This property is not
required. If there is controller param inside route pattern or inside
route match pattern property, it's used to define this record to dispatch
specific requested controller.
It should contain controller class namespaces defined in standard PHP
notation. If there is backslash at the beginning - controller class will
be loaded directly from base standard controllers directory
/App/Controllers , not by any relative place defined by possible domain
route from extended router. If there are two standard slashes in the
beginning, controller class will be loaded without those two slashes
from base PHP place without any automatic MvcCore namespace prepending.
Example: "Products" - normally placed in /App/Controllers/Products.php(but it could be also in some sub-directory if there is used extended route with namespace) "\Front\Business\Products"- placed in /App/Controllers/Front/Business/Products.php "//Anywhere\Else\Controllers\Products" - placed in /Anywhere/Else/Controllers/Products.php
|
|
protected
string
|
$action
Action name to call in dispatched controller, in pascal case. This
property is not required. If controller instance has default method
IndexAction() , its called. If there is no such method, no method is
called. If there is action param inside route pattern or inside route
match pattern property, it's used to overwrite this record to dispatch
specific requested action.
Action name to call in dispatched controller, in pascal case. This
property is not required. If controller instance has default method
IndexAction() , its called. If there is no such method, no method is
called. If there is action param inside route pattern or inside route
match pattern property, it's used to overwrite this record to dispatch
specific requested action.
If this property has value "List" , then public method in target
controller has to be named as: public function ListAction () {...} .
Example: "List"
|
|
protected
array|array[]
|
$defaults
Route rewrite params default values and also any other query string
params default values. It could be used for any application request
param from those application inputs - $_GET , $_POST or php://input .
Route rewrite params default values and also any other query string
params default values. It could be used for any application request
param from those application inputs - $_GET , $_POST or php://input .
Example: ["name" => "default-name", "color" => "red",] .
|
|
protected
array|array[]
|
$constraints
Array with param names and their custom regular expression matching
rules. Not required, for all rewrite params there is used default
matching rules from route static properties defaultDomainConstraint or
defaultPathConstraint . It should be changed to any value. Default value
is "[^.]+" for domain part and "[^/]+" for path part.
Array with param names and their custom regular expression matching
rules. Not required, for all rewrite params there is used default
matching rules from route static properties defaultDomainConstraint or
defaultPathConstraint . It should be changed to any value. Default value
is "[^.]+" for domain part and "[^/]+" for path part.
Example: ["name" => "[^/]+", "color" => "[a-z]+",]
|
|
protected
array
|
$filters
URL address params filters to filter URL params in and out. By route
filters you can change incoming request params into application and out
from application. For example to translate the values or anything else.
URL address params filters to filter URL params in and out. By route
filters you can change incoming request params into application and out
from application. For example to translate the values or anything else.
Filters are callable s and always in this array under keys "in" and
"out" accepting arguments:
- $params associative array with params from requested URL address for in filter and associative array with params to build URL address for out filter.
- $defaultParams associative array with default params to store any custom value necessary to filter effectively.
- $request current request instance implements \MvcCore\IRequest .
Callable filter must return associative array with filtered params.
There is possible to call any callable as closure function in variable
except forms like 'ClassName::methodName' and ['childClassName',
'parent::methodName'] and [$childInstance, 'parent::methodName'] .
|
|
protected
string|null
|
$method
Http method to only match requests with this defined method. If NULL ,
request with any http method could be matched by this route. Value has to
be in upper case.
Example: "POST" | \MvcCore\IRequest::METHOD_POST
Http method to only match requests with this defined method. If NULL ,
request with any http method could be matched by this route. Value has to
be in upper case.
Example: "POST" | \MvcCore\IRequest::METHOD_POST
|
|
protected
string|null
|
$redirect
Other route unique name to redirect request to. To this target route are
passed params parsed from this matched route. This property is used for
routes handling old pages or old request forms, redirecting those request
to new form.
Example: "new_route_name"
Other route unique name to redirect request to. To this target route are
passed params parsed from this matched route. This property is used for
routes handling old pages or old request forms, redirecting those request
to new form.
Example: "new_route_name"
|
|
protected
boolean
|
$absolute
Boolean about to generate absolute URL addresses. If TRUE , there is
always generated absolute URL form. If FALSE , absolute URL address is
generated only if pattern (or reverse ) property contains absolute
matching form.
Boolean about to generate absolute URL addresses. If TRUE , there is
always generated absolute URL form. If FALSE , absolute URL address is
generated only if pattern (or reverse ) property contains absolute
matching form.
|
|
protected
string|null
|
$groupName
Route group name to belongs to. Group name is always first word parsed
from request path. First word is content between two first slashes in
request path. If group name is NULL , route belongs to default group
and that group is used when no other group matching the request path.
Route group name to belongs to. Group name is always first word parsed
from request path. First word is content between two first slashes in
request path. If group name is NULL , route belongs to default group
and that group is used when no other group matching the request path.
|
|
protected
array|null
|
$reverseParams
Associative array with \stdClass objects with metadata about all
rewrite params in pattern (or reverse ) property. Every object item
has those keys about founded param place: name , greedy , sectionIndex ,
reverseStart andreverseEnd . Keys matchStart and matchEnd could
have value -1 and no real string indexes, if this metadata array is
completed only by reverse pattern (It happens if match property is
configured directly). This array is parsed automatically by route method
initMatchAndReverse(); or by route method initReverse(); after it's
necessary - to be able to complete match to match incoming request (if
match is configured as NULL ) and to complete URL address string in
method Url(); and it's sub-methods.
Example:
// For pattern /products-list/<name>[/<color*>]
[
'name' => (object) [
'name' => 'name', 'greedy' => FALSE,
'sectionIndex' => 0, 'reverseStart' => 15,
'reverseEnd' => 21, 'matchStart' => 15,
'matchEnd' => 21,
],
'color' => (object) [
'name' => 'color', 'greedy' => TRUE,
'sectionIndex' => 1, 'reverseStart' => 22,
'reverseEnd' => 30, 'matchStart' => 22,
'matchEnd' => 30,
]
];
Associative array with \stdClass objects with metadata about all
rewrite params in pattern (or reverse ) property. Every object item
has those keys about founded param place: name , greedy , sectionIndex ,
reverseStart andreverseEnd . Keys matchStart and matchEnd could
have value -1 and no real string indexes, if this metadata array is
completed only by reverse pattern (It happens if match property is
configured directly). This array is parsed automatically by route method
initMatchAndReverse(); or by route method initReverse(); after it's
necessary - to be able to complete match to match incoming request (if
match is configured as NULL ) and to complete URL address string in
method Url(); and it's sub-methods.
Example:
// For pattern /products-list/<name>[/<color*>]
[ 'name' => (object) [ 'name' => 'name', 'greedy' => FALSE, 'sectionIndex' => 0, 'reverseStart' => 15, 'reverseEnd' => 21, 'matchStart' => 15, 'matchEnd' => 21, ], 'color' => (object) [ 'name' => 'color', 'greedy' => TRUE,
'sectionIndex' => 1, 'reverseStart' => 22,
'reverseEnd' => 30, 'matchStart' => 22,
'matchEnd' => 30, ]
];
|
|
protected
array
|
$matchedParams
This associative array is used only in cloned matched route object and
there is stored all only matched rewrite params and route controller and
route action if any. All params are in raw form. Not filtered.
This associative array is used only in cloned matched route object and
there is stored all only matched rewrite params and route controller and
route action if any. All params are in raw form. Not filtered.
|
|
protected
stdClass[]
|
$reverseSections
An array with \stdClass objects with metadata about all fixed or
variable sections in pattern (or reverse ) property. Every object item
has those keys about section: fixed , start , end and length . This
array is parsed automatically by route method initMatchAndReverse(); or
by route method initReverse(); after it's necessary - to be able to
complete match to match incoming request (if match is configured as
NULL ) and to complete URL address string in method Url(); and it's
sub-methods.
Example:
// For pattern /products-list/<name>[/<color*>]
[
(object) [
'fixed' => TRUE, 'start' => 0,
'end' => 21, 'length' => 21,
],
(object) [
'fixed' => FALSE, 'start' => 21,
'end' => 30, 'length' => 9,
]
];
An array with \stdClass objects with metadata about all fixed or
variable sections in pattern (or reverse ) property. Every object item
has those keys about section: fixed , start , end and length . This
array is parsed automatically by route method initMatchAndReverse(); or
by route method initReverse(); after it's necessary - to be able to
complete match to match incoming request (if match is configured as
NULL ) and to complete URL address string in method Url(); and it's
sub-methods.
Example:
// For pattern /products-list/<name>[/<color*>]
[ (object) [ 'fixed' => TRUE, 'start' => 0, 'end' => 21, 'length' => 21, ], (object) [ 'fixed' => FALSE, 'start' => 21, 'end' => 30, 'length' => 9, ]
];
|
|
protected
string|null
|
$lastPatternParam
Optional, param name, which is founded in internal initialization process
inside pattern or inside reverse property as the last one. And after
it's value, there could be only trailing slash or nothing (pattern end).
This trailing slash param definition is used to automatically trim last
param value from right site when route is matched and rewrite params parsed.
Optional, param name, which is founded in internal initialization process
inside pattern or inside reverse property as the last one. And after
it's value, there could be only trailing slash or nothing (pattern end).
This trailing slash param definition is used to automatically trim last
param value from right site when route is matched and rewrite params parsed.
|
|
protected
int[]
|
$flags
Array with route reverse pattern flags. First item is integer flag about
defined scheme in pattern (or reverse ), second flag is about domain parts
founded in pattern (or reverse ) and third flag is about existing query
string part in pattern (or in reverse )
absolute or relative reverse form and second item is about query string
inside reverse string.
Array with route reverse pattern flags. First item is integer flag about
defined scheme in pattern (or reverse ), second flag is about domain parts
founded in pattern (or reverse ) and third flag is about existing query
string part in pattern (or in reverse )
absolute or relative reverse form and second item is about query string
inside reverse string.
|
|
protected
MvcCore\Router
|
$router
Router instance reference used mostly in route URL building process.
Router instance reference used mostly in route URL building process.
|
|
protected
array
|
$config
This array contains data from route constructor. If route is initialized
with all params (not only by single array), this array contains the fourth
param with advanced route configuration. If route is initialized only with
one single array argument, this array contains that whole configuration
single array argument. Data in this array are without no change against
initialization moment. This could be used for any advanced property to
define in extended class.
This array contains data from route constructor. If route is initialized
with all params (not only by single array), this array contains the fourth
param with advanced route configuration. If route is initialized only with
one single array argument, this array contains that whole configuration
single array argument. Data in this array are without no change against
initialization moment. This could be used for any advanced property to
define in extended class.
|
|
private
integer|null
|
$_trailingSlashBehaviour
Copied and cached value from router configuration property:
\MvcCore\Router::$trailingSlashBehaviour .
Copied and cached value from router configuration property:
\MvcCore\Router::$trailingSlashBehaviour .
|
|


UD for Buryat
Tokenization and Word Segmentation
- In general, words are delimited by whitespace characters. Description of exceptions follows.
- According to typographical rules, many punctuation marks are attached to a neighboring word. In most cases we tokenize them as separate tokens (words). The exception is hyphenated compounds such as монгол-буряадуудай / mongol-burjaaduudaj “Mongol-Buryat” (one token).
- There are no fused multi-word tokens, nor words with spaces.
Morphology
Tags
- All 17 universal POS categories are relevant for Buryat, although the current data does not contain any instance of X.
- At present, 177 lemma types are tagged PART.
- Buryat has the following auxiliary verbs (AUX):
- бай (bay) “to be” is the copula.
- боло (bolo) “to become” is used in periphrastic future and other tenses; it also functions as a pseudo-copula (but is not annotated as copula in UD).
- шада (šada) “can, be able” is a modal auxiliary.
- There are four main types of verbal forms, distinguished by the value of the VerbForm feature
(all of them are tagged VERB or AUX, not as other derived categories):
- Finite verb
Fin
can act as a predicate of a main clause without an auxiliary; it inflects for the Person of the subject. - Converb (verbal adverb)
Conv
functions as a predicate in a dependent adverbial clause. The literature distinguishes several types of converbs in Buryat; unlike in Indo-European languages, they do not necessarily share their subject with the matrix clause. We useVerbForm=Conv
for the conditional converbs (“if doing X, the matrix clause happens”), ending in -бал, -бол, -бэл. - Infinitive
Inf
. The non-finite form ending in -жа, -жо, -жэ normally has to be accompanied by an auxiliary; together they can form a predicate of a main or a dependent clause. This makes the form different from verbal adverbs and thus worth a separate label. Calling them infinitives is in line with what Washington and Tyers (2019) propose for Turkic languages; note that in earlier releases of the Buryat treebank, these forms were labeledCoverb
(see also #747). Some authors (e.g., Skribnik 2011) label them as imperfective converbs. - Gerund
Ger
is used for various other forms that are classified as types of converbs in the literature. Gerunds may function as predicates in main clauses (without an auxiliary, and with an overt subject).- бүтээ / bütee “create” → бүтээхэеэ / büteexeyee “willing to create” (intention)
- Finite verb
Nominal Features
- Case has 6 possible values:
Nom
,Gen
,Dat
,Acc
,Abl
,Com
. It occurs with the nominal words, i.e., NOUN, PROPN, PRON, ADJ, NUM. - Number: only plural is annotated with
Number=Plur
, while singular is unmarked. However, both numbers are annotated for finite verbs (cross-reference of the subject).
Syntax
- Nominal subject is normally in the nominative case. It triggers agreement on the finite verb and it determines the use of the reflexive marker in the clause, if any.
- Direct object may be in the accusative but it is often in the nominative form, too. The unmarked stem (nominative) implies an unspecified unfocused object.
- The dominant and unmarked word order is subject-object-verb (SOV).
- The verb бай / bay “be” can be used as a copula.
- If combined with a nominal in the comitative case, its meaning is possessively existential, corresponding to English “have”: Хүзүүбшэ улан үнгэтэй байгаа. / Xüzüübše ulan üngetey baygaa. lit. “neck red fox.with is” = “The red fox has a neck.”
- Buryat uses the following language-specific dependency relation subtypes:
- advmod:neg for negative particles
In Buryat, possessive existential sentences (e.g., “I have a book”) are non-verbal: “To me (dative), [there is] a book.” The owner is in the dative case and is analyzed as the predicate; the possessed thing is the subject.
Мааттида шэнэ түмэр морин . \n Maattida šene tümer morin . \n to.Maatti new iron horse .
nsubj(Мааттида, морин)
amod(морин, шэнэ)
compound(морин, түмэр)
punct(Мааттида, .-5)
“Maatti has a new car.”
Treebanks
There is one Buryat UD treebank:
References
- Elena Skribnik. 2011. Buryat. In: The Mongolic Languages. Routledge
- Jonathan North Washington, Francis M. Tyers. 2019. Delineating Turkic non-finite verb forms by syntactic function. In: Proceedings of the Workshop on Turkic and Languages in Contact with Turkic 4. 132–146


You ever wanted to find the meaning of a very well balanced diet?
Then you came to the right place. NutriBuddy is your best buddy to find the nutritional facts of your favourite food and many more. Check out our services for more in depth understanding.
 Select the user type you desire and get healthy right away. Are you a person who is considering about unhealthy artificial ingredients in foods? Not to worry, you are always in our minds, and select the Allergic user type from the user type selection menu and search for unhealthy artificial ingredients. Right now we only support for INS ingredients. (Example: E321) Here are some information about INS numbers.


Get a FREE U.S. address to forward your packages to. Once received your package will be shipped overnight to anywhere you want. It really is just that simple!
Shop online at your favorite store. When you check-out, use the U.S. address we provide.

We welcome your feedback to continuously enhance our service!


What is vomit fruit as seen on I'm a Celebrity?
When it comes to I’m a Celebrity, there are certain things that can be counted on.
A ‘sexy’ shower scene? 2019 has that covered thanks to, er, Andrew Maxwell’s budgie smugglers. Hilarious fails from well-meaning stars? Caitlyn taking a tumble might do the trick.
The great-and-gross Bushtucker trials are also integral to making the show so great – and that includes the annual tradition of force-feeding a famous face something known as vomit fruit.
What is vomit fruit?
The fruit’s proper name is Morinda citrifolia. Other names for the fruit include the Indian mulberry, noni, starvation fruit and the dog dumpling.
Not exactly names to get the appetite whet.
It’s part of the coffee family and is native across Australasia and Southeast Asia.
What does it taste like?
In what is surely a hollow victory for the celebs on I’m a Celebrity who have to face off against the fruit, it isn’t actually meant to taste like vomit.
Advertisement Advertisement
It just smells like it.
Atlas Obscura has reported how the ‘vomit fruit’ tastes in various stages of ripeness.
When unripe, the fruit is meant to have a spacy, grassy taste with hints of horseradish and parmesan – which frankly just sounds like a Heston Blumenthal dish.
When it’s fully ripe, the fruit is thought to taste like a combination of sharp cheese and lemon with hints of vomit.
Why do people eat ‘vomit fruit’?
Like with most odd culinary habits, it all comes down to the suggested health benefits.
The vomit fruit has long been used in traditional Polynesian ceremonies as it’s believed to help cure aches, cancer, anxiety, addiction and inflammation.
Shamans are reported to use the fruit to ward off evil, since the smell is that bad.
Forget the Ghostbusters, call your local vomit fruit vendor.
Who’s had to eat it on I’m a Celebrity?
This year – so far – Adele Roberts has had to chow down on the questionable culinary dish – but it was worth it to win her framed Jane McDonald photo.

Mark Wright and Carol Vorderman were both picked to eat the fruit in 2016. Mark had to eat a cricket dipped in the fruit, and Carol was treated to a ‘Sicktoria’ sponge.
Boxing champ Amir Khan was almost knocked out by a drink made from the fruit in 2017.
Advertisement Advertisement
I’m a Celebrity 2018 also saw Malique Thompson-Dwyer and Noel Edmonds knock back a glass of the blended fruit.
I’m a Celebrity…Get Me Out Of Here! continues tonight at 9:10pm on ITV.


{% if pape_request %} {% if pape_request.preferred_auth_policies %} The relying party requested the following PAPE policies be in effect:


My First Website
welcome to my website! there are some things i enjoy
web development
chess
reading
learning
Favourites Quotes
H ere is a fav quote of mine..
and another..


Login
Home
Menu
Contact
Categories
Antipasti
Pizza
Pasta
Mains
Dolci
Beverage
All rights reserved. Designed by
Ryan Paul,
Taruna Mangar, and
Evelina Iliescu-Nastasiu.


Please use epic ticket for comments, feedbacks, etc.
This is a draft document for Jenkins 2.0. None of this is real (yet).
Problem
A revamped new-user experience would help the numerous people who set up Jenkins for the first time.
Description
- Change how plugin bundling works, don't automatically install plugins just for backward compatibility
- Some emphasis on Continuous Delivery (include Pipeline Plugin)
References
- JENKINS-30749 Jenkins should be secure out of the box by default
- https://youtu.be/kzRR8XR8hu4 Initial working prototype of new experience
This particular feature has been the topic of quite a bit of discussion on the Jenkins Dev list over the past few months. The major remaining issue is determining which plugins should be suggest and/or recommended and by what process that list should be generated. That having been said, comments as to any aspect of this feature are always welcome.


| DOSE: |
20 mg |
oral |
2C-I |
(powder / crystals) |
Introduction: If I was to tell you that this was a glowing experience, what would that mean to you? If I was to tell you that it was a +4 experience, what would that mean to you?
Few words can describe the experience. Anything I would mention would be tainted by your perception of those words. In essence, what I am really trying to get at is how innappropriate and inefficient my words are in trying to express what happened.
The best I can do is tell you that the night I experienced was a fantastic evening full of wild enlightening conversation, a display of kaliedescopic emotions and visual imagery. It was a fireworks display of conciousness.
Set: Having spent a long time waiting for this experience I was quite eager to enter it. In the morning I had exhausted my energy by going on a bike ride. I had little appetite and had only eaten one small sandwich during the day. I meditated and had a fruitful session after I had returned from my bike ride. I was ready. For what I was ready for, that is what I was unsure of.
Setting: A park, suburban streets and my car. The weather was dreary but it bothered me little.
Experience:
5:00 - I had arrived at my tripping-partners place, lets call her N. I had extremely high energy fueled by the anticaption of the evening to come. N and I talked for quite a while and organised how we would go about our experience.
6:00 - After much discussion N decides to ingest 15mg and I 20mg. Our plans are to drive a nice quiet park and just relax and enjoy the experience. I bring with me a wonderful book to read regarding spirituality.
I am extremely anxious about the effects, to the point where I begin to get uncomfortable tremors. I have never experienced such bodily effects brought on by anticipation.
We decide to make a move and drive to a store and get some food. I begin to feel slightly uncomfortable in the store and am aware of mild effects. The drive down to the park is five minutes, we decide to take a chance and I do drive. I found my coordination was little debilatated and had no mental or visual effects present. Thus I decided I was capable of driving.
6:15 - Once at the park I relaxed. My intense excitment had died down a little. The feeling that began initially was quite strange. I felt there was little motivation to do anything. I felt stimulated to talk, but there wasn't a point to any conversation. I would start a conversation but I felt that its context and purpose was irrelevant.
6:30 - The effects built up quite quickly. Lots of physical stimulation, though there was no intellectual aspect. I felt quite 'dumb'. I walked to the toilet and spent a short time admiring a spider as it slowly made its way from the roof to the ground.
6:45 - The stimulation is increasing, along with a wonderful sense of giddiness. I feel a warm energy building within my solar plexus. There seem little negative effects at the moment, though the physical stimulation is still building.
7:00 - We decide to go for a walk, leaving the car was interesting. A lot of caricature ideals are presented to me whenever I change focus. Thinking is good as my train of thought is grounded, but offers a different angle to how I would normally interpret things. I have lots of time to look over others and my own issues. I begin to realize how good a person I have really been. External color perception is little changed, compared to 2c-t-7 there is very little change in the perception of the external world in a visual sense.
7:30 - Physical stimulation overflows into a blissful state similar to MDMA. I am so in control of my emotions, there is so much clarity. The visual aspect begins take a different dimension, with kaleidoscopic imagery in CEV's and OEV's. N and I are having a wonderfully exciting conversation. We talk about our issues, about our fears. Things between us are still undefined, but I let go of the fear.
8:30 - Within that hour I let go of my fears. I learn of my bruised ego. Many adventures take place. I begin to understand myself on a different level. I cry, laugh and experience a lifetime of emotions within this hour as the world becomes a timeless moment. The intensity seems to come in waves, continually building on the previous one. I am in awe of human nature. There are so many profound statements and moments, so many appropriate songs on the radio. It is a magical, colorful evening that I experience.
9:30 - The intellectual aspect continues. N and I talk and learn more and more about each other's nature. The visual aspect culminates in scenery so beautiful there are no words to describe it.
10:30 - The effects drop significantly but are still quite present. There is a very intellectual psychedelic component now, with a great deal of physical stimulation.
12:00 - The intellectual aspect continues until we are just far too exhausted to continue. I attempt to drive but realize that I cannot so we decide to wait.
1:00 - The wondrous evening ends in a warm hug. The night exchanged between us was like a dream we shared together, there is little to describe how significant this evening was between us.
Conclusion: Sleep was difficult and the next few days were bumpy, indicating that changes in brain chemistry continue to extrapolate for the next few days. Through the events of that evening I feel I have gained a far greater insight into myself and others.
Leprechaun:
'If you are unafraid of death, you realize its true meaning and will live life to its fullest.'
Experience Reports are the writings and opinions of the individual authors who submit them.
Some of the activities described are dangerous and/or illegal and none are recommended by Erowid.


Listen to me.
When I call out to you, answer me quickly.
3 For my days pass away like smoke,
and my bones burn like fire.
4 My heart is crushed, and I am like grass that has withered.

Now is the time to have mercy upon her;
the appointed time has come.
14 For your servants hold her stones dear
and feel compassion for the dust of her ruins.
15 The nations will respect your name, Yahweh,
and all the kings of the earth will honor your glory.
16 Yahweh will rebuild Zion
and will appear in his glory.
17 At that time, he will respond to the prayer of the destitute;
he will not reject their prayer.
18 This will be written for future generations,
and a people not yet born will praise Yahweh.
19 For he has looked down from the holy heights;
from heaven Yahweh has viewed the earth,
20 to hear the groaning of the prisoners,
to release those who were condemned to death.
21 Then men will proclaim the name of Yahweh in Zion
and his praise in Jerusalem
22 when the peoples and kingdoms gather together
to serve Yahweh.
23 He has taken away my strength in the middle of life.


Ruby Classes
Class Methods and Variables vs. Instance Methods and Variables
November 9, 2014
Classes are first-class objects, each of which are instances of the class Class. Once created, you can set methods and attributes so that whenever a new instance of that class is created, it has contained within it a set of properties via instance variables and methods.
To create a class, you use the following syntax:
You’ll want some setup code, using a constructor is called initialize.
It takes a few parameters, so that when you create an instance, it looks like this.
You can set the instance variables, accessible to your individual instances of the class in one of two ways:
Or for a concise syntactical variation:
Class Methods vs. Instance Methods
Within the class, you can create different methods to call on each instance of the class. For instance, you can create a simple “greeting” method that spits up a string introducing the person - which you would call on an instance of the class, not the class itself. This is an instance method.
Otherwise, a class method are for anything that does not deal with an individual instance of a class. it applies to the entire class itself. Here are two common ways to create a class method.
Class variables vs. Instance Variables
Class variables that aren’t accessible from individual instances of the class, but from the class itself. Let’s return a class method that denotes how many instances of the Person class has been created. We use the @@ to denote a variable at class level and @ to denote at an instance level.
We create a class variable that corresponds to the number of instances that have been created @@count. We place a counter within the initialize variable that keeps track of this data. Then we create a class method that allows us to access this information. Note that each individual instance of Person, like Roberto from Argentina, doesn’t have access to this information, but only the class itself can keep track of how many people are being created.


import torch.nn as nn
model = nn.Sequential(
nn.Conv2d(3, 20, 5, 1),
nn.ReLU(),
nn.MaxPool2d(2, 2),
nn.Conv2d(20, 50, 5, 1),
nn.ReLU(),
nn.MaxPool2d(2, 2),
nn.Flatten(),
nn.Linear(800, 500),
nn.ReLU(),
nn.Linear(500, 10),
)
import torch.nn as nn
from norse.torch import LICell
from norse.torch import LIFCell
from norse.torch import SequentialState
model = SequentialState(
nn.Conv2d(3, 20, 5, 1),
LIFCell(),
nn.MaxPool2d(2, 2),
nn.Conv2d(20, 50, 5, 1),
LIFCell(),
nn.MaxPool2d(2, 2),
nn.Flatten(),
nn.Linear(800, 500),
LIFCell(),
nn.Linear(500, 10),
LICell(),
)


How to change key format for serialization
This section shows how to change the serialized TOML key format
public class Root
{
public int firstprop { get; set; } = 1;
public int secondProp { get; set; } = 2;
public int ThirdProp { get; set; } = 3;
public int FOURTHPROP { get; set; } = 4;
}
var pascalSettings = TomlSettings.Create(s => s
.ConfigurePropertyMapping(m => m
.UseKeyGenerator(standardGenerators => standardGenerators.PascalCase)));
var upperSettings = TomlSettings.Create(s => s
.ConfigurePropertyMapping(m => m
.UseKeyGenerator(standardGenerators => standardGenerators.UperCase)));
var lowerSettings = TomlSettings.Create(s => s
.ConfigurePropertyMapping(m => m
.UseKeyGenerator(standardGenerators => standardGenerators.LowerCase)));
var camelSettings = TomlSettings.Create(s => s
.ConfigurePropertyMapping(m => m
.UseKeyGenerator(standardGenerators => standardGenerators.LowerCase)));
var defaultToml = Toml.WriteString(new Root());
var pascal = Toml.WriteString(new Root(), pascalSettings);
var upper = Toml.WriteString(new Root(), upperSettings);
var lower = Toml.WriteString(new Root(), lowerSettings);
var camel = Toml.WriteString(new Root(), camelSettings);
Default TOML:
firstprop = 1
secondProp = 2
ThirdProp = 3
FOURTHPROP = 4
Pascal:
Firstprop = 1
SecondProp = 2
ThirdProp = 3
FOURTHPROP = 4
Upper:
FIRSTPROP = 1
SECONDPROP = 2
THIRDPROP = 3
FOURHTPROP = 4
Lower:
firstprop = 1
secondprop = 2
thirdprop = 3
fourthprop = 4
Camel:
firstprop = 1
secondProp = 2
ThirdProp = 3
FOURTHPROP = 4
How to ignore key format for property mapping
TOML is case sensitive. By default Nett
will not map TOML values to
the corresponding object property if they are not exactly the same.
You can make Nett ignore the case of the target property by using
the IgnoreCase
target property selector:
public class TestObject
{
public string TestProp { get; set; }
}
// Create custom settings with 'IgnoreCase' property selector enabled
var settings = TomlSettings.Create(s => s
.ConfigurePropertyMapping(m => m
.UseTargetPropertySelector(standardSelectors => standardSelectors.IgnoreCase)));
const string TomlInput = "TestProp = 'x'";
// Deserialize TOML file content with default settings
var exact = Toml.ReadString<TestObject>(TomlInput);
// Deserialize TOML file content with custom settings enabled
var ignoreCase = Toml.ReadString<TestObject>(TomlInput, settings);
Debug.Assert(exact.TestProp == null);
Debug.Assert(ignoreCase.TestProp == "x");
Warning: If the IgnoreCase
target property selector is used
and the input TOML has multiple keys that only differ in casing
testprop = 1
TestProp = 2
The mapping behavior is undefined.


public class SelectionModelAdapter<ItemType>
extends java.lang.Object
implements javax.swing.ListSelectionModel
SubsetSelectionModel
to a ListSelectionModel
.
The ListSelectionModel (jlist) supports quite complex selection modes:
ctrl-click , dragging, and combinations of these. We really only want to
support dragging so we ignore the ctrl- and removal stuff.| Constructor and Description |
|---|
SelectionModelAdapter(SubsetSelectionModel<ItemType> model) |
| Modifier and Type | Method and Description |
|---|---|
void |
addListSelectionListener(javax.swing.event.ListSelectionListener x) |
void |
addSelectionInterval(int index0,
int index1) |
void |
clearSelection() |
int |
getAnchorSelectionIndex() |
int |
getLeadSelectionIndex() |
int |
getMaxSelectionIndex() |
int |
getMinSelectionIndex() |
int |
getSelectionMode() |
boolean |
getValueIsAdjusting() |
void |
insertIndexInterval(int index,
int length,
boolean before) |
boolean |
isSelectedIndex(int index) |
boolean |
isSelectionEmpty() |
void |
removeIndexInterval(int index0,
int index1) |
void |
removeListSelectionListener(javax.swing.event.ListSelectionListener x) |
void |
removeSelectionInterval(int index0,
int index1) |
void |
setAnchorSelectionIndex(int index) |
void |
setLeadSelectionIndex(int index) |
void |
setSelectionInterval(int index0,
int index1) |
void |
setSelectionMode(int selectionMode) |
void |
setValueIsAdjusting(boolean valueIsAdjusting) |
public SelectionModelAdapter(SubsetSelectionModel<ItemType> model)
public void setSelectionInterval(int index0, int index1)
setSelectionInterval
in interface javax.swing.ListSelectionModel
public void addSelectionInterval(int index0, int index1)
addSelectionInterval
in interface javax.swing.ListSelectionModel
public void removeSelectionInterval(int index0, int index1)
removeSelectionInterval
in interface javax.swing.ListSelectionModel
public int getMinSelectionIndex()
getMinSelectionIndex
in interface javax.swing.ListSelectionModel
public int getMaxSelectionIndex()
getMaxSelectionIndex
in interface javax.swing.ListSelectionModel
public boolean isSelectedIndex(int index)
isSelectedIndex
in interface javax.swing.ListSelectionModel
public int getAnchorSelectionIndex()
getAnchorSelectionIndex
in interface javax.swing.ListSelectionModel
public void setAnchorSelectionIndex(int index)
setAnchorSelectionIndex
in interface javax.swing.ListSelectionModel
public int getLeadSelectionIndex()
getLeadSelectionIndex
in interface javax.swing.ListSelectionModel
public void setLeadSelectionIndex(int index)
setLeadSelectionIndex
in interface javax.swing.ListSelectionModel
public void clearSelection()
clearSelection
in interface javax.swing.ListSelectionModel
public boolean isSelectionEmpty()
isSelectionEmpty
in interface javax.swing.ListSelectionModel
public void insertIndexInterval(int index, int length, boolean before)
insertIndexInterval
in interface javax.swing.ListSelectionModel
public void removeIndexInterval(int index0, int index1)
removeIndexInterval
in interface javax.swing.ListSelectionModel
public void setValueIsAdjusting(boolean valueIsAdjusting)
setValueIsAdjusting
in interface javax.swing.ListSelectionModel
public boolean getValueIsAdjusting()
getValueIsAdjusting
in interface javax.swing.ListSelectionModel
public void setSelectionMode(int selectionMode)
setSelectionMode
in interface javax.swing.ListSelectionModel
public int getSelectionMode()
getSelectionMode
in interface javax.swing.ListSelectionModel
public void addListSelectionListener(javax.swing.event.ListSelectionListener x)
addListSelectionListener
in interface javax.swing.ListSelectionModel
public void removeListSelectionListener(javax.swing.event.ListSelectionListener x)
removeListSelectionListener
in interface javax.swing.ListSelectionModel


Leave queue
Queue Sales Chat Status
Queue Sales Rich Media Status
Queue Service Chat Status
Queue Service Rich Media Chat Status


This is a work in progress and currently only works for version 1 (verification code 241) of the bomb manual which can be found here.
Horizontal Wires
Is the last digit of the serial number odd?
Yes
No
The Button
Color: White
Blue
Yellow
Red
Label: Abort
Hold
Detonate
Number of batteries:
Indicators: CAR
FRK
Solution:
Blue strip: release when the countdown timer has a 4 in any position.
White strip: release when the countdown timer has a 1 in any position.
Yellow strip: release when the countdown timer has a 5 in any position.
Any other color strip: release when the countdown timer has a 1 in any position.
The Knob
1 = light is on
0 = light is off
For example: 110000 means that only the first two LEDs are on.
Both keys needed in order to guarantee a correct answer.


These options affect how this gist is displayed on Bitty. A bitty.json file is placed in the gist to store these.
bitty.json


2 Thessalonians 2:9
Even him, whose coming is after the working of Satan with all power and signs and lying wonders,


{% if entry.subheading|length %}
{# # Homepage template # ----------------- # # This template gets loaded whenever the site's homepage is requested, because # the "Homepage" single-entry section's Template setting is set to "index". # # An `entry` variable will be automatically passed to this template, which will # be set to the Homepage entry. -#} {% extends "_layouts/site" %} {% block main %}
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer nec odio.