ixbrl-viewer 1.4.1__py3-none-any.whl → 1.4.86__py3-none-any.whl

iXBRLViewerPlugin/xhtmlserialize.py

@@ -1,8 +1,12 @@
 # See COPYRIGHT.md for copyright information
 
-from lxml import etree
-from enum import Enum
+from __future__ import annotations
+
 import re
+from enum import Enum
+from typing import IO
+
+from lxml import etree
 
 XHTML_NS = 'http://www.w3.org/1999/xhtml'
 XML_NS = 'http://www.w3.org/XML/1998/namespace'
@@ -34,31 +38,31 @@ class XHTMLSerializer:
     ATTR_ESCAPE_RE = re.compile('([' + MUST_ESCAPE_CHARS + '>"])')
     STYLE_ESCAPE_RE = re.compile('([' + MUST_ESCAPE_CHARS + ']|' + CDATA_END + ')')
 
-    def __init__(self, fout, xml_declaration = True, assume_xhtml = True):
+    def __init__(self, fout: IO[bytes], xml_declaration: bool = True, assume_xhtml: bool = True) -> None:
         self.fout = fout
         self.encoding = "utf-8"
         self.xml_declaration = xml_declaration
         self.assume_xhtml = assume_xhtml
 
-    def write(self, s):
+    def write(self, s: str) -> None:
         self.fout.write(s.encode(self.encoding))
 
-    def prefix_sort(self, p):
+    def prefix_sort(self, p: str | None) -> str:
         return p if p is not None else '0'
 
-    def qname_for_node(self, node):
-        qname = etree.QName(node.tag)
+    def qname_for_node(self, node: etree._Element) -> str:
+        qname = etree.QName(node)
         if qname.namespace is None:
             prefix = None
         elif node.nsmap.get(node.prefix, None) == qname.namespace:
             prefix = node.prefix
         else:
-            prefix = next(iter(sorted((p for p, ns in nsmap.items() if ns == qname.namespace), key = self.prefix_sort)))
+            prefix = next(iter(sorted((p for p, ns in node.nsmap.items() if ns == qname.namespace), key = self.prefix_sort)))
         if prefix is None:
             return qname.localname
-        return "%s:%s" % (prefix, qname.localname)
+        return f"{prefix}:{qname.localname}"
 
-    def qname_for_attr(self, tag, nsmap):
+    def qname_for_attr(self, tag: etree._Element | str, nsmap: dict[str | None, str]) -> str:
         qname = etree.QName(tag)
         if qname.namespace is None:
             return qname.localname
@@ -66,9 +70,9 @@ class XHTMLSerializer:
             prefix = 'xml'
         else:
             prefix = next(iter(sorted((p for p, ns in nsmap.items() if ns == qname.namespace and p is not None), key = self.prefix_sort)))
-        return "%s:%s" % (prefix, qname.localname)
+        return f"{prefix}:{qname.localname}"
 
-    def is_selfclosable(self, n):
+    def is_selfclosable(self, n: etree._Element | str) -> bool:
         qname = etree.QName(n)
         return (
                 qname.localname in XHTMLSerializer.SELF_CLOSABLE
@@ -76,22 +80,22 @@ class XHTMLSerializer:
                     qname.namespace == XHTML_NS
                     or (self.assume_xhtml and qname.namespace is None)))
 
-    def escape_attr(self, s):
+    def escape_attr(self, s: str) -> str:
         return self.ATTR_ESCAPE_RE.sub(lambda m: self.escape_str(m[0]), s)
 
-    def xmlns_declaration(self, prefix, uri):
+    def xmlns_declaration(self, prefix: str | None, uri: str) -> str:
         if prefix is None:
-            return 'xmlns="%s"' % self.escape_attr(uri)
-        return 'xmlns:%s="%s"' % (prefix, self.escape_attr(uri))
+            return f'xmlns="{self.escape_attr(uri)}"'
+        return f'xmlns:{prefix}="{self.escape_attr(uri)}"'
 
-    def namespace_declarations(self, new_nsmap, cur_nsmap):
+    def namespace_declarations(self, new_nsmap: dict[str | None, str], cur_nsmap: dict[str | None, str]) -> list[str]:
         changed = set(p[0] for p in (set(new_nsmap.items()) ^ set(cur_nsmap.items())))
         return sorted(self.xmlns_declaration(p, new_nsmap[p]) for p in changed)
 
-    def escape_str(self, c):
-        return self.ESCAPES.get(c, '&#x%02X;' % ord(c[0]))
+    def escape_str(self, c: str) -> str:
+        return self.ESCAPES.get(c, f'&#x{ord(c[0]):02X};')
 
-    def write_escape_text(self, s, escape_mode):
+    def write_escape_text(self, s: str | None, escape_mode: EscapeMode) -> None:
         if s is None:
             return
         if escape_mode == EscapeMode.STYLE:
@@ -105,24 +109,31 @@ class XHTMLSerializer:
         else:
             self.write(self.ESCAPE_RE.sub(lambda m: self.escape_str(m[0]),s))
 
-    def write_attributes(self, node):
+    def write_attributes(self, node: etree._Element) -> None:
         for qname, value in sorted((self.qname_for_attr(k, node.nsmap), v) for k, v in node.items()):
-            self.write(' %s="' % qname)
+            self.write(f' {qname}="')
             self.write(self.escape_attr(value))
             self.write("\"")
 
-    def write_comment(self, n, escape_mode):
+    def write_comment(self, n: etree._Comment, escape_mode: EscapeMode) -> None:
         self.write('<!--' + n.text + '-->')
         self.write_escape_text(n.tail, escape_mode)
 
-    def write_processing_instruction(self, n, escape_mode):
+    def write_processing_instruction(self, n: etree._ProcessingInstruction, escape_mode: EscapeMode) -> None:
         self.write( '<?' + n.target )
         if n.text != '':
             self.write(' ' + n.text)
         self.write('?>')
         self.write_escape_text(n.tail, escape_mode)
 
-    def write_node(self, n, nsmap = {}, escape_mode = EscapeMode.DEFAULT):
+    def write_node(
+        self,
+        n: etree._Element,
+        nsmap: dict[str | None, str] | None = None,
+        escape_mode: EscapeMode = EscapeMode.DEFAULT,
+    ) -> None:
+        if nsmap is None:
+            nsmap = {}
         if isinstance(n, etree._Comment):
             self.write_comment(n, escape_mode)
         elif isinstance(n, etree._ProcessingInstruction):
@@ -130,18 +141,22 @@ class XHTMLSerializer:
         else:
             self.write_element(n, nsmap, escape_mode)
 
-    def write_element(self, n, parent_nsmap = {}, escape_mode = EscapeMode.DEFAULT):
+    def write_element(
+        self,
+        n: etree._Element,
+        parent_nsmap: dict[str | None, str] | None = None,
+        escape_mode: EscapeMode = EscapeMode.DEFAULT,
+    ) -> None:
+        if parent_nsmap is None:
+            parent_nsmap = {}
         name = self.qname_for_node(n)
-        qname = etree.QName(n.tag)
+        qname = etree.QName(n)
         selfclose = len(n) == 0 and n.text is None and self.is_selfclosable(n)
-        parts = [ name ] + self.namespace_declarations(n.nsmap, parent_nsmap) 
+        parts = [ name ] + self.namespace_declarations(n.nsmap, parent_nsmap)
         self.write('<' + ' '.join(parts))
         self.write_attributes(n)
 
-        if qname.localname == 'style':
-            inner_escape_mode = EscapeMode.STYLE
-        else:
-            inner_escape_mode = escape_mode
+        inner_escape_mode = EscapeMode.STYLE if qname.localname == 'style' else escape_mode
 
         if selfclose:
             self.write('/>')
@@ -150,11 +165,11 @@ class XHTMLSerializer:
             self.write_escape_text(n.text, inner_escape_mode)
             for child in n.iterchildren():
                 self.write_node(child, n.nsmap, inner_escape_mode)
-            self.write('</%s>' % name)
+            self.write(f'</{name}>')
 
         self.write_escape_text(n.tail, escape_mode)
 
-    def write_xml_declaration(self, docinfo = None):
+    def write_xml_declaration(self, docinfo: etree.DocInfo | None = None) -> None:
         if self.xml_declaration:
             version = "1.0"
             standalone = ""
@@ -162,23 +177,22 @@ class XHTMLSerializer:
                 version = docinfo.xml_version
                 if docinfo.standalone:
                     standalone = ' standalone="yes"'
-            self.write('<?xml version="%s" encoding="%s"%s?>\n' % (version, self.encoding, standalone))
+            self.write(f'<?xml version="{version}" encoding="{self.encoding}"{standalone}?>\n')
 
-    def serialize(self, element):
-        if hasattr(element, 'getroot'):
+    def serialize(self, element: etree._ElementTree[etree._Element] | etree._Element) -> None:
+        if isinstance(element, etree._ElementTree):
             self.write_xml_declaration(element.docinfo)
 
-            element = element.getroot()
-            while element.getprevious() is not None:
-                element = element.getprevious()
+            node: etree._Element | None = element.getroot()
+            while node is not None and node.getprevious() is not None:
+                node = node.getprevious()
 
-            while element is not None:
-                self.write_node(element)
-                if isinstance(element, (etree._Comment, etree._ProcessingInstruction)):
+            while node is not None:
+                self.write_node(node)
+                if isinstance(node, (etree._Comment, etree._ProcessingInstruction)):
                     self.write("\n")
-                element = element.getnext()
+                node = node.getnext()
 
         else:
             self.write_xml_declaration()
             self.write_element(element)
-

{ixbrl_viewer-1.4.1.dist-info → ixbrl_viewer-1.4.86.dist-info}/METADATA

@@ -1,9 +1,9 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: ixbrl-viewer
-Version: 1.4.1
+Version: 1.4.86
 Summary: The Arelle iXBRL Viewer allows iXBRL reports to be viewed interactively in a web browser.
 Author-email: "arelle.org" <support@arelle.org>
-License: Apache-2.0
+License-Expression: Apache-2.0
 Project-URL: Homepage, https://arelle.org/
 Project-URL: Downloads, https://arelle.org/arelle/pub/
 Project-URL: Documentation, https://arelle.org/arelle/documentation/
@@ -16,64 +16,115 @@ Platform: any
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: End Users/Desktop
 Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Natural Language :: English
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Operating System :: OS Independent
 Classifier: Topic :: Text Processing :: Markup :: XML
-Requires-Python: >=3.8
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
-License-File: LICENSE
+License-File: LICENSE.md
 License-File: NOTICE
-Requires-Dist: arelle-release ==2.*
-Requires-Dist: lxml ==4.*
-Requires-Dist: pycountry ==22.*
+Requires-Dist: bottle<0.14,>=0.13
+Requires-Dist: lxml<7,>=4
+Provides-Extra: arelle
+Requires-Dist: arelle_release==2.*; extra == "arelle"
 Provides-Extra: dev
-Requires-Dist: nose2 ==0.13.0 ; extra == 'dev'
-Requires-Dist: typing-extensions ==4.7.1 ; extra == 'dev'
+Requires-Dist: flake8==7.3.0; extra == "dev"
+Requires-Dist: mypy==1.19.1; extra == "dev"
+Requires-Dist: pytest==9.0.2; extra == "dev"
+Requires-Dist: types-lxml==2026.1.1; extra == "dev"
+Requires-Dist: typing-extensions==4.15.0; extra == "dev"
+Dynamic: license-file
 
 # Arelle iXBRL Viewer
 
+[![PyPI](https://img.shields.io/pypi/v/ixbrl-viewer)](https://pypi.org/project/ixbrl-viewer/)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/ixbrl-viewer)](https://pypi.org/project/ixbrl-viewer/)
+[![NPM Version](https://img.shields.io/npm/v/ixbrl-viewer)](https://www.npmjs.com/package/ixbrl-viewer)
+[![Read the Docs](https://img.shields.io/readthedocs/arelle-ixbrl-viewer)](https://arelle-ixbrl-viewer.readthedocs.io/)
+
 ![ixbrl-viewer](https://raw.githubusercontent.com/Arelle/ixbrl-viewer/master/examples/ixbrl-viewer-demo.gif)
 
+## Table of Contents
+
+- [Arelle iXBRL Viewer](#arelle-ixbrl-viewer)
+  - [Table of Contents](#table-of-contents)
+  - [Description](#description)
+  - [Documentation](#documentation)
+  - [Installation](#installation)
+  - [Accessing the JavaScript viewer application](#accessing-the-javascript-viewer-application)
+    - [Accessing via the CDN](#accessing-via-the-cdn)
+    - [Accessing via Github](#accessing-via-github)
+    - [Building the JavaScript locally](#building-the-javascript-locally)
+  - [JavaScript Versioning](#javascript-versioning)
+  - [Producing an ixbrl-viewer via the Arelle GUI](#producing-an-ixbrl-viewer-via-the-arelle-gui)
+    - [Preparing an iXBRL file via the GUI](#preparing-an-ixbrl-file-via-the-gui)
+    - [Preparing an iXBRL document set using the Arelle GUI](#preparing-an-ixbrl-document-set-using-the-arelle-gui)
+  - [Producing an ixbrl-viewer via the Arelle command line](#producing-an-ixbrl-viewer-via-the-arelle-command-line)
+    - [Preparing an iXBRL file via the command line](#preparing-an-ixbrl-file-via-the-command-line)
+    - [Preparing an iXBRL document set](#preparing-an-ixbrl-document-set)
+    - [Using build-viewer.py](#using-build-viewerpy)
+  - [Stub viewer mode](#stub-viewer-mode)
+  - [Optional Features](#optional-features)
+    - [Feature: Review Mode](#feature-review-mode)
+  - [Runtime config](#runtime-config)
+  - [Disable viewer loading](#disable-viewer-loading)
+  - [Running tests](#running-tests)
+    - [Running unit tests](#running-unit-tests)
+    - [Running Puppeteer tests](#running-puppeteer-tests)
+  - [👥 Contributors](#-contributors)
+  - [License](#license)
+
+## Description
+
 The [Arelle](https://arelle.org/) iXBRL Viewer allows [Inline XBRL](https://www.xbrl.org/ixbrl) (or iXBRL) reports to be
 viewed interactively in a web browser.  The viewer allows users to access the tagged XBRL data embedded in an iXBRL
 report.  Key features include:
 
-* Full text search on taxonomy labels and references
-* View full details of tagged facts
-* Export tables to Excel
-* Visualize and navigate calculation relationships
-* Produce on-the-fly graphs using XBRL data
+- Full text search on taxonomy labels and references
+- View full details of tagged facts
+- Export tables to Excel
+- Visualize and navigate calculation relationships
+- Produce on-the-fly graphs using XBRL data
 
 A sample viewer is provided in the [examples](https://github.com/Arelle/ixbrl-viewer/blob/master/examples/README.md) for those interested.
 
 The viewer project consists of two components:
 
-* A plugin for the [Arelle](https://www.arelle.org) XBRL tool
-* The Javascript viewer application
+- A plugin for the [Arelle](https://www.arelle.org) XBRL tool
+- The Javascript viewer application
 
 In order to view an iXBRL report in the viewer, it must first be prepared using
 the Arelle plugin.  The preparation process updates the iXBRL file to include:
 
-1. A link to the Javascript viewer
+1. A link to the JavaScript viewer
 2. A block of JSON data that contains the results of processing the XBRL data and associated taxonomy
 
-Once prepared, the resulting file provides an entirely standalone viewer.  Once
-prepared, the viewer is entirely standalone, and does not require access to the
-taxonomy, or to any online services.  The only dependency is on the javascript
-viewer application, which is a single file which can be accessed directly online, downloaded or built locally.
+Once prepared, the resulting file provides an entirely standalone viewer, and
+does not require access to the taxonomy, or to any online services.  The only
+dependency is on the JavaScript viewer application, which is a single file
+which can be accessed directly online, downloaded or built locally.
+
+It is also possible to place the link to the viewer, and the block of JSON data
+in a separate file.  See Stub Viewer Mode below.
+
+The JavaScript viewer application is a single JavaScript file called ixbrlviewer.js. It
+contains all of the JavaScript that runs the viewer functionality.
 
-The javascript viewer application is a single Javascript file called ixbrlviewer.js. It
-contains all of the javascript that runs the viewer functionality.
+## Documentation
+
+Need help with the Arelle iXBRL Viewer? Go check out [our documentation][read-the-docs].
+
+[read-the-docs]: https://arelle-ixbrl-viewer.readthedocs.io/
 
 ## Installation
 
-The python portion of this repo is developed using Python 3.11.
+The Python portion of this repo is developed using Python 3.14.
 
 1. Clone the [iXBRL Viewer git repository][ixbrlviewer-github].
 2. Download and install [Arelle][arelle-download]
@@ -113,11 +164,15 @@ the ixbrl-viewer.
 
 ## JavaScript Versioning
 
-The ixbrl-viewer plugin embeds processed XBRL metadata in the HTML that has a specific format read
-by the JavaScript. The metadata produced by a version will be broken if a major version bump is
-released. The new javascript won't necessarily work with older versions of the generated metadata.
-if a minor version bump is released, then the metadata format was updated, any ixbrl-viewer produced
-on that minor version will have to use at least that minor version for the javascript.
+The ixbrl-viewer plugin embeds processed XBRL metadata in the HTML that has a
+specific format read by the JavaScript. The metadata produced will work with a
+viewer application that has the same major version, and the same or later minor
+version as the plugin used to create it.
+
+This means that once an XBRL report has been prepared by the plugin, the
+associated JavaScript viewer application can be upgraded within the same major
+version.  Any features introduced in newer versions of the viewer that rely on
+additional metadata will degrade gracefully if that metadata is not present.
 
 ## Producing an ixbrl-viewer via the Arelle GUI
 
@@ -163,9 +218,9 @@ python3 Arelle/arelleCmdLine.py --plugins=<path to iXBRLViewerPlugin> -f ixbrl-r
 
 Notes:
 
-* "Arelle/arelleCmdLine.py" should be the path to your installation of Arelle
-* The plugin path needs to an absolute file path to the ixbrl-viewer plugin
-* The viewer url can be one of the following:
+- "Arelle/arelleCmdLine.py" should be the path to your installation of Arelle
+- The plugin path needs to an absolute file path to the ixbrl-viewer plugin
+- The viewer url can be one of the following:
 
   1. `https://cdn.jsdelivr.net/npm/ixbrl-viewer@<version>/iXBRLViewerPlugin/viewer/dist/ixbrlviewer.js`
   2. A relative url to the downloaded ixviewer.js from github
@@ -195,17 +250,20 @@ python3 Arelle/arelleCmdLine.py --plugins '/path/to/iXBRLViewerPlugin|inlineXbrl
 
 Notes:
 
-* The first file specified is the "primary" file, and should be opened in a
+- The first file specified is the "primary" file, and should be opened in a
   browser to use the viewer.  The other files will be loaded in separate tabs
   within the viewer.
-* "Arelle/arelleCmdLine.py" should be the path to your installation of Arelle
-* The plugin path needs to an absolute file path to the ixbrl-viewer plugin
-* The viewer url can be one of the following:
+- "Arelle/arelleCmdLine.py" should be the path to your installation of Arelle
+- The plugin path needs to an absolute file path to the ixbrl-viewer plugin
+- The viewer url can be one of the following:
 
   1. `https://cdn.jsdelivr.net/npm/ixbrl-viewer@<version>/iXBRLViewerPlugin/viewer/dist/ixbrlviewer.js`
   2. A relative url to the downloaded ixviewer.js from github
   3. A relative url to the locally built ixviewer.js
 
+- Due to browser security restrictions, the resulting viewer cannot be loaded
+  directly from `file:` URLs; it must be served by a web server.
+
 ### Using build-viewer.py
 
 As an alternative to the standard Arelle command line, the
@@ -229,10 +287,33 @@ e.g.
 ```shell
 PYTHONPATH=/path/to/Arelle:/path/to/ixbrl-viewer ./samples/build-viewer.py --out out-dir --package-dir /my/packages/ ixds-dir
 ```
-# Optional Features
+
+## Stub viewer mode
+
+By default, the link to the JavaScript viewer and the JSON data block are added
+to the iXBRL report file (or to the first file, in the case of a document set).  
+
+Stub viewer mode is an optional generation mode that creates an additional,
+minimal HTML file containing the JSON data block, and the link to the
+JavaScript viewer.  This mode has two advantages over the default approach of
+embedding the JSON data and JavaScript link in the iXBRL report:
+
+1. Provided that all facts and footnotes in the iXBRL report already have ID
+   attributes, no modification of the iXBRL report is required.
+2. The iXBRL viewer loading mask will be displayed much more quickly.  This is
+   helpful for very large iXBRL reports which can otherwise result in a long
+   delay before there is any sign of the iXBRL Viewer loading.
+
+The downside of this mode is that due to browser security restrictions, the
+viewer cannot be loaded directly from files (using `file:` URLs); they must be
+served by a web server.
+
+## Optional Features
+
 Some features are disabled by default but can be enabled at generation time or with query parameters.
 
 To enable features:
+
 - Via CLI: `--viewer-feature-{feature name}`
 - Via query parameter:`?{feature name}=true`
 
@@ -251,7 +332,8 @@ This table uses the 'review' feature as an example to demonstrate how these opti
 | `review` | `true`      | `enabled`  |
 | `review` | `false`     | `disabled` |
 
-## Feature: Review Mode
+### Feature: Review Mode
+
 ![ixbrl-viewer](https://raw.githubusercontent.com/Arelle/ixbrl-viewer/master/examples/review-mode.png)
 
 A review mode is available that is intended to assist in reviewing partially tagged or incomplete documents.
@@ -261,6 +343,40 @@ This mode replaces the namespace-based highlighting with optional highlighting b
 |---------------------------|----------------|
 | `--viewer-feature-review` | `?review=true` |
 
+## Runtime config
+
+When launched, the viewer will check for the existence of
+`ixbrlviewer.config.json` in the same directory as `ixbrlviewer.js`.  If found,
+this will be loaded and used to configure the viewer.
+
+The file supports the following keys:
+
+- `features` - a JSON object containing defaults for features. These will be
+overridden by features defined at generation time, and then by query
+parameters, as defined above.
+
+- `skin` - a JSON object supporting the following keys:
+
+  - `stylesheetUrl` - a URL to additional CSS definitions.
+  - `faviconUrl` - a URL to an icon file to be used as the favicon for the viewer.
+  - `footerLogoHtml` - a fragment of HTML that will be included in place of the standard footer logo.
+
+- `taxonomyNames` - a JSON object where:
+
+  - Keys are strings that will be treated as a regular expression to match
+      against a namespace.
+  - Values are an array of (prefix, name) where "prefix" is the preferred
+      namespace prefix for the namespace, and "name" is a short descriptive
+      name for the taxonomy.
+
+Relative URLs defined in the config file are resolved relative to the config file.
+
+## Disable viewer loading
+
+Loading of the viewer can be disabled by specifying `?disable-viewer` as a
+query parameter.  This will leave the iXBRL document loaded in the browser, but
+without any viewer functionality.  In the case of an iXBRL document set, or
+multi-document viewer, the first document will be shown.
 
 ## Running tests
 
@@ -272,7 +388,7 @@ Run the following command to run javascript unit tests: `npm run test`
 
 In order to run the python unit tests make sure that you have pip installed requirements-dev.txt.
 
-Run the following command to run python unit tests: `nose2`
+Run the following command to run python unit tests: `pytest tests/unit_tests`
 
 ### Running Puppeteer tests
 
@@ -282,7 +398,7 @@ All commands should be run from repository root
 2. Install Arelle
 
     ```shell
-    pip install arelle-release .
+    pip install .[arelle]
     ```
 
 3. [Terminal 1] Start the puppeteer serve
@@ -291,16 +407,31 @@ All commands should be run from repository root
     npm run puppeteerServe 
     ```
 
-    * This command generates the `ixbrlviewer.js`, uses Arelle to generate several test files, then serves the files via a nodejs http-server.
-    * Currently changes to application code require restarting this step to take effect.
+    - This command generates the `ixbrlviewer.js`, uses Arelle to generate several test files, then serves the files via a nodejs http-server.
+    - Currently changes to application code require restarting this step to take effect.
 4. Start the puppeteer tests
-    * [Terminal 2]:
+    - [Terminal 2]:
 
        ```shell
        npm run test:puppeteer
        ```
 
-    * IDE:
-      * Many of the IDE's on the market can run tests via the UI.  The following is an example configuration for intellij.  Once set you can right-click on the test name or file and select the run option.
+    - IDE:
+      - Many of the IDE's on the market can run tests via the UI.  The following is an example configuration for intellij.  Once set you can right-click on the test name or file and select the run option.
       ![ixbrl-viewer](https://raw.githubusercontent.com/Arelle/ixbrl-viewer/master/tests/puppeteer/puppeteer_test_run_via_intellij.jpg)
-      * Debug runs with breakpoints are also typically supported.
+      - Debug runs with breakpoints are also typically supported.
+
+## 👥 Contributors
+
+<div align="center">
+  <a href="https://github.com/Arelle/ixbrl-viewer/graphs/contributors">
+    <img src="https://contrib.rocks/image?repo=Arelle/ixbrl-viewer&max=100&columns=10" style="margin: 5px;" />
+  </a>
+  <p>Join our community and become a contributor today! 🚀 </p>
+</div>
+
+## License
+
+[Apache License 2.0][license]
+
+[license]: https://arelle-ixbrl-viewer.readthedocs.io/en/latest/license.html