diff --git a/_static/css/custom.css b/_static/css/custom.css
index 6dcfae6..3bc3e60 100644
--- a/_static/css/custom.css
+++ b/_static/css/custom.css
@@ -13,4 +13,32 @@
.wy-table-responsive {
overflow: visible !important;
+}
+
+
+.wrapper {
+ position: relative;
+ display: inline-block;
+ width: 100%;
+ height: 40px;
+}
+
+.description {
+ width: 95%;
+ text-overflow: clip;
+ display: -webkit-box;
+ overflow: hidden;
+ -webkit-line-clamp: 1;
+ -webkit-box-orient: vertical;
+ height: 40px;
+}
+
+.btn {
+ /* margin: 0; padding: 0 0 0 -30px; */
+ background-color: transparent; border-width: 0; outline-width: 0;
+ font-size: 20px; color: #2f58df;
+ position: absolute;
+ /* bottom: 15px; */
+ right: 5%;
+ cursor: pointer;
}
\ No newline at end of file
diff --git a/_static/js/search.js b/_static/js/search.js
new file mode 100644
index 0000000..4f17f4a
--- /dev/null
+++ b/_static/js/search.js
@@ -0,0 +1,23 @@
+function searchtable(searchbar_id, table_to_search) {
+// Declare variables
+var input, filter, table, tr, td, i, txtValue, show;
+input = document.getElementById(searchbar_id);
+filter = input.value.toUpperCase();
+table = document.getElementById(table_to_search);
+tr = table.getElementsByTagName("tr");
+// Loop through all table rows, and hide those who don't match the search query
+for (i = 0; i < tr.length; i++) {
+ td = tr[i].getElementsByTagName("td")[0];
+ show = "none";
+ if (td) {
+ for (j = 0; j < tr[i].getElementsByTagName("td").length; j++) {
+ column = tr[i].getElementsByTagName("td")[j];
+ txtValue = column.textContent || column.innerText;
+ if (txtValue.toUpperCase().indexOf(filter) > -1) {
+ show = "";
+ }
+ }
+ tr[i].style.display = show;
+ }
+}
+}
\ No newline at end of file
diff --git a/apx-parameters.rst b/apx-parameters.rst
index b9ef68a..b2bfd8c 100644
--- a/apx-parameters.rst
+++ b/apx-parameters.rst
@@ -14,116 +14,162 @@ Client parameters
Parameters recognized in configuration files under /etc/cvmfs:
+.. note::
+ Javascript functions must be declared in ``_static/js`` and the file must be added to the ``conf.py`` with ``html_js_files = ['js/search.js',]``
-=============================== ========================================================================================
-**Parameter** **Meaning**
-=============================== ========================================================================================
-CVMFS_ALIEN_CACHE If set, use an alien cache at the given location
-CVMFS_ALT_ROOT_PATH | If set to *yes*, use alternative root catalog path.
- | Only required for fixed catalogs (tag / hash) under the alternative path.
-CVMFS_AUTO_UPDATE If set to *no*, disables the automatic update of file catalogs.
-CVMFS_AUTHZ_HELPER Full path to an authz helper, overwrites the helper hint in the catalog.
-CVMFS_AUTHZ_SEARCH_PATH Full path to the directory that contains the authz helpers.
-CVMFS_BACKOFF_INIT Seconds for the maximum initial backoff when retrying to download data.
-CVMFS_BACKOFF_MAX Maximum backoff in seconds when retrying to download data.
-CVMFS_CATALOG_WATERMARK | Try to release pinned catalogs when their number surpasses the given watermark.
- | Defaults to 1/4 CVMFS_NFILES; explicitly set by shrinkwrap.
-CVMFS_CACHE_BASE Location (directory) of the CernVM-FS cache.
-CVMFS_CHECK_PERMISSIONS If set to *no*, disable checking of file ownership and permissions (open all files).
-CVMFS_CLAIM_OWNERSHIP If set to *yes*, allows CernVM-FS to claim ownership of files and directories.
-CVMFS_DEBUGLOG If set, run CernVM-FS in debug mode and write a verbose log the the specified file.
-CVMFS_DEFAULT_DOMAIN | The default domain will be automatically appended to repository names
- | when given without a domain.
-CVMFS_DNS_MIN_TTL | Minimum effective TTL in seconds for DNS queries of proxy server names
- | (not Stratum 1s). Defaults to 1 minute.
-CVMFS_DNS_MAX_TTL | Maximum effective TTL in seconds for DNS queries of proxy server names
- | (not Stratum 1s). Defaults to 1 day.
-CVMFS_DNS_RETRIES Number of retries when resolving proxy names
-CVMFS_DNS_TIMEOUT Timeout in seconds when resolving proxy names
-CVMFS_DNS_ROAMING If true, watch /etc/resolv.conf for nameserver changes
-CVMFS_ENFORCE_ACLS | Enforce POSIX ACLs stored in the repository. Requires libfuse 3.
-CVMFS_EXTERNAL_FALLBACK_PROXY | List of HTTP proxies similar to ``CVMFS_EXTERNAL_HTTP_PROXY``.
- | The fallback proxies are added to the end of the normal proxies,
- | and disable DIRECT connections.
-CVMFS_EXTERNAL_HTTP_PROXY Chain of HTTP proxy groups to be used when CernVM-FS is accessing external data
-CVMFS_EXTERNAL_TIMEOUT Timeout in seconds for HTTP requests to an external-data server with a proxy server
-CVMFS_EXTERNAL_TIMEOUT_DIRECT Timeout in seconds for HTTP requests to an external-data server without a proxy server
-CVMFS_EXTERNAL_URL Semicolon-separated chain of webservers serving external data chunks.
-CVMFS_FALLBACK_PROXY | List of HTTP proxies similar to ``CVMFS_HTTP_PROXY``. The fallback proxies are
- | added to the end of the normal proxies, and disable DIRECT connections.
-CVMFS_FOLLOW_REDIRECTS When set to *yes*, follow up to 4 HTTP redirects in requests.
-CVMFS_HIDE_MAGIC_XATTRS If set to *yes* the client will not expose CernVM-FS specific extended attributes
-CVMFS_HOST_RESET_AFTER See ``CVMFS_PROXY_RESET_AFTER``.
-CVMFS_HTTP_PROXY | Chain of HTTP proxy groups used by CernVM-FS. Necessary.
- | Set to ``DIRECT`` if you don't use proxies.
-CVMFS_IGNORE_SIGNATURE When set to *yes*, don't verify CernVM-FS file catalog signatures.
-CVMFS_INITIAL_GENERATION Initial inode generation. Used for testing.
-CVMFS_INSTRUMENT_FUSE | When set to *true* gather performance statistics about the FUSE callbacks.
- | The results are displayed with `cvmfs_talk internal affairs`.
-CVMFS_NFS_INTERLEAVED_INODES In NFS mode, use only inodes of the form :math:`an+b`, specified as "b%a".
-CVMFS_IPFAMILY_PREFER Which IP protocol to prefer when connecting to proxies. Can be either 4 or 6.
-CVMFS_KCACHE_TIMEOUT Timeout in seconds for path names and file attributes in the kernel file system buffers.
-CVMFS_KEYS_DIR | Directory containing \*.pub files used as repository signing keys.
- | If set, this parameter has precedence over ``CVMFS_PUBLIC_KEY``.
-CVMFS_LOW_SPEED_LIMIT Minimum transfer rate in bytes/second a server or proxy must provide.
-CVMFS_MAX_EXTERNAL_SERVERS | Limit the number of (geo sorted) stratum 1 servers for external data
- | that are effectively used.
-CVMFS_MAX_IPADDR_PER_PROXY | Limit the number of IP addresses a proxy names resolves into.
- | From all registered addresses, up to the limit are randomly selected.
-CVMFS_MAX_RETRIES Maximum number of retries for a given proxy/host combination.
-CVMFS_MAX_SERVERS Limit the number of (geo sorted) stratum 1 servers that are effectively used.
-CVMFS_MAX_TTL Maximum file catalog TTL in minutes. Can overwrite the TTL stored in the catalog.
-CVMFS_MEMCACHE_SIZE Size of the CernVM-FS meta-data memory cache in Megabyte.
-CVMFS_MOUNT_RW | Mount CernVM-FS as a read/write file system. Write operations will fail
- | but this option can workaround faulty ``open()`` flags.
-CVMFS_NFILES Maximum number of open file descriptors that can be used by the CernVM-FS process.
-CVMFS_NFS_SOURCE If set to *yes*, act as a source for the NFS daemon (NFS export).
-CVMFS_NFS_SHARED | If set a path, used to store the NFS maps in an SQlite database,
- | instead of the usual LevelDB storage in the cache directory.
-CVMFS_PAC_URLS Chain of URLs pointing to PAC files with HTTP proxy configuration information.
-CVMFS_OOM_SCORE_ADJ | Set the Linux kernel's out-of-memory killer priority
- | for the CernVM-FS client [-1000 - 1000].
-CVMFS_PROXY_RESET_AFTER | Delay in seconds after which CernVM-FS will retry the primary proxy group
- | in case of a fail-over to another group.
-CVMFS_PROXY_SHARD | If set to *yes*, shard requests across all proxies within the current
- | load-balancing group using consistent hashing.
-CVMFS_PROXY_TEMPLATE Overwrite the default proxy template in Geo-API calls. Only needed for debugging.
-CVMFS_PUBLIC_KEY Colon-separated list of repository signing keys.
-CVMFS_QUOTA_LIMIT Soft-limit of the cache in Megabyte.
-CVMFS_RELOAD_SOCKETS Directory of the sockets used by the CernVM-FS loader to trigger hotpatching/reloading.
-CVMFS_REPOSITORIES | Comma-separated list of fully qualified repository names
- | to include in use of client utilities such as ``cvmfs_talk`` and ``cvmfs_config``.
- | Does not limit which repositories may be mounted, unless ``CVMFS_STRICT_MOUNT`` is
- | set to *yes*.
-CVMFS_REPOSITORY_DATE | A timestamp in ISO format (e.g. ``2007-03-01T13:00:00Z``).
- | Selects the repository state as of the given date.
-CVMFS_REPOSITORY_TAG Select a named repository snapshot that should be mounted instead of ``trunk``.
-CVMFS_CONFIG_REPO_REQUIRED If set to *yes*, no repository can be mounted unless the config repository is available.
-CVMFS_ROOT_HASH Hash of the root file catalog, implies ``CVMFS_AUTO_UPDATE=no``.
-CVMFS_SEND_INFO_HEADER If set to *yes*, include the cvmfs path of downloaded data in HTTP headers.
-CVMFS_SERVER_CACHE_MODE Enable special cache semantics for a client used as a publisher's repository base line.
-CVMFS_SERVER_URL Semicolon-separated chain of Stratum~1 servers.
-CVMFS_SHARED_CACHE If set to *no*, makes a repository use an exclusive cache.
-CVMFS_STRICT_MOUNT If set to *yes*, mount only repositories that are listed in ``CVMFS_REPOSITORIES``.
-CVMFS_SUID If set to *yes*, enable suid magic on the mounted repository. Requires mounting as root.
-CVMFS_SYSLOG_FACILITY | If set to a number between 0 and 7, uses the corresponding
- | LOCAL$n$ facility for syslog messages.
-CVMFS_SYSLOG_LEVEL | If set to 1 or 2, sets the syslog level for CernVM-FS messages to
- | LOG_DEBUG or LOG_INFO respectively.
-CVMFS_SYSTEMD_NOKILL | If set to *yes*, modify the command line to ``@vmfs2 ...`` in order to
- | act as a systemd lowlevel storage manager.
-CVMFS_TIMEOUT Timeout in seconds for HTTP requests with a proxy server.
-CVMFS_TIMEOUT_DIRECT Timeout in seconds for HTTP requests without a proxy server.
-CVMFS_TRACEFILE If set, enables the tracer and trace file system calls to the given file.
-CVMFS_USE_GEOAPI Request order of Stratum 1 servers and fallback proxies via Geo-API.
-CVMFS_USER Sets the ``gid`` and ``uid`` mount options. Don't touch or overwrite.
-CVMFS_USYSLOG | All messages that normally are logged to syslog are re-directed to the given file.
- | This file can grow up to 500kB and there is one step of log rotation.
- | Required for $\mu$CernVM.
-CVMFS_WORKSPACE Set the local directory for storing special files (defaults to the cache directory).
-CVMFS_USE_SSL_SYSTEM_CA | When connecting to an HTTPS endpoints,
- | it will load the certificates provided by the system.
-=============================== ========================================================================================
+Declaration of search bar
+::
+
+ .. raw:: html
+
+
+
+
+
+
+.. raw:: html
+
+
+
+
+
+
+
+
+Declaration of table
+::
+
+ .. table:: Client Parameter
+ :name: tableclientparams
+
+ =============================== ========================================================================================
+ **Parameter** **Meaning**
+ =============================== ========================================================================================
+ CVMFS_ALIEN_CACHE If set, use an alien cache at the given location
+
+
+.. note::
+ ``:name:`` of table must be lowercase, and only letters a-z
+
+
+.. table:: Client Parameter
+ :name: tableclientparams
+
+ =============================== ========================================================================================
+ **Parameter** **Meaning**
+ =============================== ========================================================================================
+ CVMFS_ALIEN_CACHE If set, use an alien cache at the given location
+ CVMFS_ALT_ROOT_PATH | If set to *yes*, use alternative root catalog path.
+ | Only required for fixed catalogs (tag / hash) under the alternative path.
+ CVMFS_AUTO_UPDATE If set to *no*, disables the automatic update of file catalogs.
+ CVMFS_AUTHZ_HELPER Full path to an authz helper, overwrites the helper hint in the catalog.
+ CVMFS_AUTHZ_SEARCH_PATH Full path to the directory that contains the authz helpers.
+ CVMFS_BACKOFF_INIT Seconds for the maximum initial backoff when retrying to download data.
+ CVMFS_BACKOFF_MAX Maximum backoff in seconds when retrying to download data.
+ CVMFS_CATALOG_WATERMARK | Try to release pinned catalogs when their number surpasses the given watermark.
+ | Defaults to 1/4 CVMFS_NFILES; explicitly set by shrinkwrap.
+ CVMFS_CACHE_BASE Location (directory) of the CernVM-FS cache.
+ CVMFS_CHECK_PERMISSIONS If set to *no*, disable checking of file ownership and permissions (open all files).
+ CVMFS_CLAIM_OWNERSHIP If set to *yes*, allows CernVM-FS to claim ownership of files and directories.
+ CVMFS_DEBUGLOG If set, run CernVM-FS in debug mode and write a verbose log the the specified file.
+ CVMFS_DEFAULT_DOMAIN | The default domain will be automatically appended to repository names
+ | when given without a domain.
+ CVMFS_DNS_MIN_TTL | Minimum effective TTL in seconds for DNS queries of proxy server names
+ | (not Stratum 1s). Defaults to 1 minute.
+ CVMFS_DNS_MAX_TTL | Maximum effective TTL in seconds for DNS queries of proxy server names
+ | (not Stratum 1s). Defaults to 1 day.
+ CVMFS_DNS_RETRIES Number of retries when resolving proxy names
+ CVMFS_DNS_TIMEOUT Timeout in seconds when resolving proxy names
+ CVMFS_DNS_ROAMING If true, watch /etc/resolv.conf for nameserver changes
+ CVMFS_ENFORCE_ACLS | Enforce POSIX ACLs stored in the repository. Requires libfuse 3.
+ CVMFS_EXTERNAL_FALLBACK_PROXY | List of HTTP proxies similar to ``CVMFS_EXTERNAL_HTTP_PROXY``.
+ | The fallback proxies are added to the end of the normal proxies,
+ | and disable DIRECT connections.
+ CVMFS_EXTERNAL_HTTP_PROXY Chain of HTTP proxy groups to be used when CernVM-FS is accessing external data
+ CVMFS_EXTERNAL_TIMEOUT Timeout in seconds for HTTP requests to an external-data server with a proxy server
+ CVMFS_EXTERNAL_TIMEOUT_DIRECT Timeout in seconds for HTTP requests to an external-data server without a proxy server
+ CVMFS_EXTERNAL_URL Semicolon-separated chain of webservers serving external data chunks.
+ CVMFS_FALLBACK_PROXY | List of HTTP proxies similar to ``CVMFS_HTTP_PROXY``. The fallback proxies are
+ | added to the end of the normal proxies, and disable DIRECT connections.
+ CVMFS_FOLLOW_REDIRECTS When set to *yes*, follow up to 4 HTTP redirects in requests.
+ CVMFS_HIDE_MAGIC_XATTRS If set to *yes* the client will not expose CernVM-FS specific extended attributes
+ CVMFS_HOST_RESET_AFTER See ``CVMFS_PROXY_RESET_AFTER``.
+ CVMFS_HTTP_PROXY | Chain of HTTP proxy groups used by CernVM-FS. Necessary.
+ | Set to ``DIRECT`` if you don't use proxies.
+ CVMFS_IGNORE_SIGNATURE When set to *yes*, don't verify CernVM-FS file catalog signatures.
+ CVMFS_INITIAL_GENERATION Initial inode generation. Used for testing.
+ CVMFS_INSTRUMENT_FUSE | When set to *true* gather performance statistics about the FUSE callbacks.
+ | The results are displayed with `cvmfs_talk internal affairs`.
+ CVMFS_NFS_INTERLEAVED_INODES In NFS mode, use only inodes of the form :math:`an+b`, specified as "b%a".
+ CVMFS_IPFAMILY_PREFER Which IP protocol to prefer when connecting to proxies. Can be either 4 or 6.
+ CVMFS_KCACHE_TIMEOUT Timeout in seconds for path names and file attributes in the kernel file system buffers.
+ CVMFS_KEYS_DIR | Directory containing \*.pub files used as repository signing keys.
+ | If set, this parameter has precedence over ``CVMFS_PUBLIC_KEY``.
+ CVMFS_LOW_SPEED_LIMIT Minimum transfer rate in bytes/second a server or proxy must provide.
+ CVMFS_MAX_EXTERNAL_SERVERS | Limit the number of (geo sorted) stratum 1 servers for external data
+ | that are effectively used.
+ CVMFS_MAX_IPADDR_PER_PROXY | Limit the number of IP addresses a proxy names resolves into.
+ | From all registered addresses, up to the limit are randomly selected.
+ CVMFS_MAX_RETRIES Maximum number of retries for a given proxy/host combination.
+ CVMFS_MAX_SERVERS Limit the number of (geo sorted) stratum 1 servers that are effectively used.
+ CVMFS_MAX_TTL Maximum file catalog TTL in minutes. Can overwrite the TTL stored in the catalog.
+ CVMFS_MEMCACHE_SIZE Size of the CernVM-FS meta-data memory cache in Megabyte.
+ CVMFS_MOUNT_RW | Mount CernVM-FS as a read/write file system. Write operations will fail
+ | but this option can workaround faulty ``open()`` flags.
+ CVMFS_NFILES Maximum number of open file descriptors that can be used by the CernVM-FS process.
+ CVMFS_NFS_SOURCE If set to *yes*, act as a source for the NFS daemon (NFS export).
+ CVMFS_NFS_SHARED | If set a path, used to store the NFS maps in an SQlite database,
+ | instead of the usual LevelDB storage in the cache directory.
+ CVMFS_PAC_URLS Chain of URLs pointing to PAC files with HTTP proxy configuration information.
+ CVMFS_OOM_SCORE_ADJ | Set the Linux kernel's out-of-memory killer priority
+ | for the CernVM-FS client [-1000 - 1000].
+ CVMFS_PROXY_RESET_AFTER | Delay in seconds after which CernVM-FS will retry the primary proxy group
+ | in case of a fail-over to another group.
+ CVMFS_PROXY_SHARD | If set to *yes*, shard requests across all proxies within the current
+ | load-balancing group using consistent hashing.
+ CVMFS_PROXY_TEMPLATE Overwrite the default proxy template in Geo-API calls. Only needed for debugging.
+ CVMFS_PUBLIC_KEY Colon-separated list of repository signing keys.
+ CVMFS_QUOTA_LIMIT Soft-limit of the cache in Megabyte.
+ CVMFS_RELOAD_SOCKETS Directory of the sockets used by the CernVM-FS loader to trigger hotpatching/reloading.
+ CVMFS_REPOSITORIES | Comma-separated list of fully qualified repository names
+ | to include in use of client utilities such as ``cvmfs_talk`` and ``cvmfs_config``.
+ | Does not limit which repositories may be mounted, unless ``CVMFS_STRICT_MOUNT`` is
+ | set to *yes*.
+ CVMFS_REPOSITORY_DATE | A timestamp in ISO format (e.g. ``2007-03-01T13:00:00Z``).
+ | Selects the repository state as of the given date.
+ CVMFS_REPOSITORY_TAG Select a named repository snapshot that should be mounted instead of ``trunk``.
+ CVMFS_CONFIG_REPO_REQUIRED If set to *yes*, no repository can be mounted unless the config repository is available.
+ CVMFS_ROOT_HASH Hash of the root file catalog, implies ``CVMFS_AUTO_UPDATE=no``.
+ CVMFS_SEND_INFO_HEADER If set to *yes*, include the cvmfs path of downloaded data in HTTP headers.
+ CVMFS_SERVER_CACHE_MODE Enable special cache semantics for a client used as a publisher's repository base line.
+ CVMFS_SERVER_URL Semicolon-separated chain of Stratum~1 servers.
+ CVMFS_SHARED_CACHE If set to *no*, makes a repository use an exclusive cache.
+ CVMFS_STRICT_MOUNT If set to *yes*, mount only repositories that are listed in ``CVMFS_REPOSITORIES``.
+ CVMFS_SUID If set to *yes*, enable suid magic on the mounted repository. Requires mounting as root.
+ CVMFS_SYSLOG_FACILITY | If set to a number between 0 and 7, uses the corresponding
+ | LOCAL$n$ facility for syslog messages.
+ CVMFS_SYSLOG_LEVEL | If set to 1 or 2, sets the syslog level for CernVM-FS messages to
+ | LOG_DEBUG or LOG_INFO respectively.
+ CVMFS_SYSTEMD_NOKILL | If set to *yes*, modify the command line to ``@vmfs2 ...`` in order to
+ | act as a systemd lowlevel storage manager.
+ CVMFS_TIMEOUT Timeout in seconds for HTTP requests with a proxy server.
+ CVMFS_TIMEOUT_DIRECT Timeout in seconds for HTTP requests without a proxy server.
+ CVMFS_TRACEFILE If set, enables the tracer and trace file system calls to the given file.
+ CVMFS_USE_GEOAPI Request order of Stratum 1 servers and fallback proxies via Geo-API.
+ CVMFS_USER Sets the ``gid`` and ``uid`` mount options. Don't touch or overwrite.
+ CVMFS_USYSLOG | All messages that normally are logged to syslog are re-directed to the given file.
+ | This file can grow up to 500kB and there is one step of log rotation.
+ | Required for $\mu$CernVM.
+ CVMFS_WORKSPACE Set the local directory for storing special files (defaults to the cache directory).
+ CVMFS_USE_SSL_SYSTEM_CA | When connecting to an HTTPS endpoints,
+ | it will load the certificates provided by the system.
+ =============================== ========================================================================================
.. _apxsct_serverparameters:
diff --git a/conf.py b/conf.py
index f44234e..cfdc84a 100644
--- a/conf.py
+++ b/conf.py
@@ -31,16 +31,22 @@
extensions = [
'sphinx.ext.todo',
'sphinx.ext.mathjax',
- 'sphinxcontrib.mermaid'
+ 'sphinxcontrib.mermaid',
+ 'myst_parser',
+ 'sphinx_design', # pip install sphinx-design
+ #maybe needed: pip install sphinxcontrib-plantuml
]
+# https://myst-parser.readthedocs.io/en/v0.17.1/syntax/optional.html#syntax-admonitions
+myst_enable_extensions = [ "colon_fence" ]
+
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
-# source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+source_suffix = ['.rst', '.md']
+#source_suffix = ['.rst']
# The encoding of source files.
#source_encoding = 'utf-8-sig'
@@ -160,6 +166,10 @@
'css/custom.css',
]
+html_js_files = [
+ 'js/search.js',
+]
+
# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
diff --git a/index.rst b/index.rst
index 4813de7..108d93d 100644
--- a/index.rst
+++ b/index.rst
@@ -51,6 +51,7 @@ Contents
cpt-containers
part-advanced
part-appendix
+ part-md
Contact and Authors
diff --git a/md_test1.md b/md_test1.md
new file mode 100644
index 0000000..47059ba
--- /dev/null
+++ b/md_test1.md
@@ -0,0 +1,264 @@
+(md_test_label1)=
+# Markdown Test
+
+- This [here](https://docs.readthedocs.io/en/stable/guides/migrate-rest-myst.html) is a documentation how to migrate from rst to md
+
+- Most important functionality needed here is listed below
+
+(md_test_label2)=
+## Codesections
+Inline codesection `my code is here` written by using `` around the text
+
+### Codeblocks
+
+Using ``` or ~~~ following the optional code block type (c++, vim, py,...) and a new line.
+
+~~~
+```vim
+sudo cvmfs_config setup
+
+cvmfs_config chksetup
+--> OK
+```
+~~~
+
+creates
+
+```vim
+sudo cvmfs_config setup
+
+cvmfs_config chksetup
+--> OK
+```
+
+
+(md_test_label3)=
+## Tables
+```
+|Option|Function|
+|---|---|
+|CVMFS_HTTP_PROXY|Proxy setting for repos|
+|CVMFS_QUOTA_LIMIT|Quota in MB of local cvmfs cache|
+```
+
+creates
+
+|Option|Function|
+|---|---|
+|CVMFS_HTTP_PROXY|Proxy setting for repos|
+|CVMFS_QUOTA_LIMIT|Quota in MB of local cvmfs cache|
+
+### Searchable tables
+...are to find in {ref}`searchable_table`
+
+## Labels
+
+### Reference to a file
+
+`[test](cpt-xcache.rst)` creates [test](cpt-xcache.rst)
+
+### Create custom label
+In markdown
+```
+(md_test_label3)=
+## Tables
+and the normal text follows
+this label style is not a markdown style specific to sphinx
+```
+
+In rst
+```
+.. _apxsct_serverparameters:
+```
+
+### Referencing a custom label
+- Does not dependent if it is in local file or some other part of the documentation
+- Labels must be unique accross all files
+
+In markdown
+```
+{ref}`Use label from this md file`.
+{ref}`md_test2_label`.
+{ref}`If using text-based labels you need to provide test `.
+{ref}`Use label from rst part of docs without underscore _ `.
+
+```
+
+{ref}`Use label from this md file`.
+
+{ref}`md_test2_label`.
+
+{ref}`If using text-based labels you need to provide text `.
+
+{ref}`Use label from rst part of docs without underscore _ `.
+
+
+## Admonition
+See [official doc](https://myst-parser.readthedocs.io/en/latest/syntax/admonitions.html)
+
+Use
+```
+:::{note}
+ Some note
+:::
+```
+to create a note.
+
+:::{note}
+ Some note
+:::
+
+For custom title
+```
+:::{admonition} My custom title
+ :class: note
+
+ My custom note
+:::
+```
+
+:::{admonition} My custom title
+ :class: note
+
+ My custom note
+:::
+
+### Other supported admonitions
+- attention
+- caution
+- danger
+- error
+- hint
+- important
+- note
+- seealso
+- tip
+
+:::{attention}
+ Some attention
+:::
+
+:::{caution}
+ Some caution
+:::
+
+:::{danger}
+ Some danger
+:::
+
+:::{error}
+ Some error
+:::
+
+:::{important}
+ Some important
+:::
+
+:::{tip}
+ Some tip
+:::
+
+:::{note}
+ Some note
+:::
+
+:::{seealso}
+ Some seealso
+:::
+
+Use {func}`spam` instead.
+
+Further reads are [Get started with MyST in Sphinx](https://myst-parser.readthedocs.io/en/v0.17.1/sphinx/intro.html)
+and [MyST - Directives](https://myst-parser.readthedocs.io/en/v0.17.1/syntax/syntax.html#syntax-directives)
+
+# Sphinx Design
+
+Add `sphinx_design` to `extensions` in `conf.py` and install it for python with `pip install sphinx-design`.
+
+[Official doc](https://sphinx-design.readthedocs.io/en/furo-theme/)
+
+This allows to do stuff like e.g. this
+
+## Tabs
+
+```
+::::{tab-set}
+
+:::{tab-item} Label1
+Content 1
+:::
+
+:::{tab-item} Label2
+Content 2
+:::
+
+::::
+```
+
+::::{tab-set}
+
+:::{tab-item} Label1
+Content 1
+:::
+
+:::{tab-item} Label2
+Content 2
+:::
+
+::::
+
+## Dropdowns
+
+```
+:::{dropdown} Dropdown title
+:animate: fade-in-slide-down
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed iaculis arcu vitae odio gravida congue. Donec porttitor ac risus et condimentum. Phasellus bibendum ac risus a sollicitudin. Proin pulvinar risus ac mauris aliquet fermentum et varius nisi. Etiam sit amet metus ac ipsum placerat congue semper non diam. Nunc luctus tincidunt ipsum id eleifend. Ut sed faucibus ipsum. Aliquam maximus dictum posuere. Nunc vitae libero nec enim tempus euismod. Aliquam sed lectus ac nisl sollicitudin ultricies id at neque. Aliquam fringilla odio vitae lorem ornare, sit amet scelerisque orci fringilla. Nam sed arcu dignissim, ultrices quam sit amet, commodo ipsum. Etiam quis nunc at ligula tincidunt eleifend.
+:::
+```
+
+:::{dropdown} Dropdown title
+:animate: fade-in-slide-down
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed iaculis arcu vitae odio gravida congue. Donec porttitor ac risus et condimentum. Phasellus bibendum ac risus a sollicitudin. Proin pulvinar risus ac mauris aliquet fermentum et varius nisi. Etiam sit amet metus ac ipsum placerat congue semper non diam. Nunc luctus tincidunt ipsum id eleifend. Ut sed faucibus ipsum. Aliquam maximus dictum posuere. Nunc vitae libero nec enim tempus euismod. Aliquam sed lectus ac nisl sollicitudin ultricies id at neque. Aliquam fringilla odio vitae lorem ornare, sit amet scelerisque orci fringilla. Nam sed arcu dignissim, ultrices quam sit amet, commodo ipsum. Etiam quis nunc at ligula tincidunt eleifend.
+:::
+
+## Images
+
+Images can be included with ``.
+
+
+
+If they need special options (e.g. size) use
+```html
+
+
+```
+
+
+
+Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
+
+## Mermaid graphics
+Can be included with
+
+~~~
+```{mermaid}
+graph LR
+ a --> b
+```
+~~~
+
+```{mermaid}
+graph LR
+ a --> b
+```
+
+## Other Markdown Stuff
+- `*Cursive*` *Cursive*
+- `**Bold**` **Bold**
+- `something` underline something
+- To comment stuff out within the md file use html comment `< !-- remove the space before the ! for comment section -->`
+
diff --git a/md_test2.md b/md_test2.md
new file mode 100644
index 0000000..bac5e15
--- /dev/null
+++ b/md_test2.md
@@ -0,0 +1,76 @@
+(cvmfs_test_title)=
+# Another MD Testfile
+
+Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
+
+(md_test2_label)=
+## Label In Other Markdown File
+Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
+
+(md_test2_label2)=
+My text-only label
+
+(searchable_table)=
+## Search a table
+
+Modified example from [W3Schools](https://www.w3schools.com/howto/howto_js_filter_table.asp) combined with sphinx,
+and added that all columns are searched for hit, not just the first one.
+Javascript is directly embedded in this page.
+
+
+
+
+
+
+
+
+
+
+
+:::{table}
+ :name: myTable
+ | Name | Country |
+ | ------------------- | ------- |
+ | Alfreds Futterkiste | Germany |
+ | asfasdf | Sweden |
+ | Island | UKss |
+ | Konasd | Germany |
+:::
+
+:::{note}
+ The name in table `:name: myTable` will be transformed into lower-case and can be accessed in
+ js with `document.getElementById("mytable");`
+:::
+
+
+:::{note}
+ For rest implementation of a searchable table have a look at `apx_parameters`
+:::
\ No newline at end of file
diff --git a/part-md.rst b/part-md.rst
new file mode 100644
index 0000000..e9ead49
--- /dev/null
+++ b/part-md.rst
@@ -0,0 +1,9 @@
+********************
+Markdown Integration
+********************
+
+.. toctree::
+ :maxdepth: 2
+
+ md_test1
+ md_test2