Merge pull request #1464 from p-l-/doc-obsidian

Doc: add Obsidian plugin use-case

doc/conf.py

@@ -20,7 +20,7 @@
 
 # pylint: disable=wrong-import-position,redefined-builtin
 project = "IVRE"
-copyright = "2011 - 2022, Pierre LALET"
+copyright = "2011 - 2023, Pierre LALET"
 author = "Pierre LALET"
 html_logo = "../web/static/logo.png"
 master_doc = "index"

doc/usage/use-cases.rst

@@ -122,6 +122,26 @@ To learn more about this connector, have a look at `its documentation
 
 |opencti_connector_passive|
 
+Obsidian plugin
+---------------
+
+`Obsidian <https://obsidian.md/>`_ is a knowledge base and note-taking
+application that relies on Markdown files.
+
+A `community plugin <https://github.com/ivre/obsidian-ivre-plugin>`_
+exists that uses IVRE's data to create notes based on IVRE's data that
+provides context to your notes related to pentest or red team
+engagements, bug bounty hunting, cyber threat intelligence, etc.
+
+See the `plugin's README
+<https://github.com/ivre/obsidian-ivre-plugin/blob/master/README.md>`_.
+
+|obsidian_graph|
+
+|obsidian_domain|
+
+|obsidian_host|
+
 Blog posts and other resources
 ------------------------------
 
@@ -175,3 +195,6 @@ so that we can add a link here!
 .. |cortex_analyzer_template| image:: ../screenshots/cortex-analyzer-template.png
 .. |opencti_connector_scans| image:: ../screenshots/opencti-connector-scans.png
 .. |opencti_connector_passive| image:: ../screenshots/opencti-connector-passive.png
+.. |obsidian_graph| image:: https://raw.githubusercontent.com/ivre/obsidian-ivre-plugin/master/doc/screenshots/graph_thunderbird.png
+.. |obsidian_domain| image:: https://raw.githubusercontent.com/ivre/obsidian-ivre-plugin/master/doc/screenshots/domain_1password.png
+.. |obsidian_host| image:: https://raw.githubusercontent.com/ivre/obsidian-ivre-plugin/master/doc/screenshots/address_1password.png

web/static/doc/_sources/usage/use-cases.rst.txt

@@ -122,6 +122,26 @@ To learn more about this connector, have a look at `its documentation
 
 |opencti_connector_passive|
 
+Obsidian plugin
+---------------
+
+`Obsidian <https://obsidian.md/>`_ is a knowledge base and note-taking
+application that relies on Markdown files.
+
+A `community plugin <https://github.com/ivre/obsidian-ivre-plugin>`_
+exists that uses IVRE's data to create notes based on IVRE's data that
+provides context to your notes related to pentest or red team
+engagements, bug bounty hunting, cyber threat intelligence, etc.
+
+See the `plugin's README
+<https://github.com/ivre/obsidian-ivre-plugin/blob/master/README.md>`_.
+
+|obsidian_graph|
+
+|obsidian_domain|
+
+|obsidian_host|
+
 Blog posts and other resources
 ------------------------------
 
@@ -175,3 +195,6 @@ so that we can add a link here!
 .. |cortex_analyzer_template| image:: ../screenshots/cortex-analyzer-template.png
 .. |opencti_connector_scans| image:: ../screenshots/opencti-connector-scans.png
 .. |opencti_connector_passive| image:: ../screenshots/opencti-connector-passive.png
+.. |obsidian_graph| image:: https://raw.githubusercontent.com/ivre/obsidian-ivre-plugin/master/doc/screenshots/graph_thunderbird.png
+.. |obsidian_domain| image:: https://raw.githubusercontent.com/ivre/obsidian-ivre-plugin/master/doc/screenshots/domain_1password.png
+.. |obsidian_host| image:: https://raw.githubusercontent.com/ivre/obsidian-ivre-plugin/master/doc/screenshots/address_1password.png

web/static/doc/_static/basic.css

@@ -236,16 +236,6 @@ div.body p, div.body dd, div.body li, div.body blockquote {
 a.headerlink {
     visibility: hidden;
 }
-a.brackets:before,
-span.brackets > a:before{
-    content: "[";
-}
-
-a.brackets:after,
-span.brackets > a:after {
-    content: "]";
-}
-
 
 h1:hover > a.headerlink,
 h2:hover > a.headerlink,
@@ -334,11 +324,17 @@ aside.sidebar {
 p.sidebar-title {
     font-weight: bold;
 }
+
+nav.contents,
+aside.topic,
 div.admonition, div.topic, blockquote {
     clear: left;
 }
 
 /* -- topics ---------------------------------------------------------------- */
+
+nav.contents,
+aside.topic,
 div.topic {
     border: 1px solid #ccc;
     padding: 7px;
@@ -377,13 +373,17 @@ div.body p.centered {
 
 div.sidebar > :last-child,
 aside.sidebar > :last-child,
+nav.contents > :last-child,
+aside.topic > :last-child,
 div.topic > :last-child,
 div.admonition > :last-child {
     margin-bottom: 0;
 }
 
 div.sidebar::after,
 aside.sidebar::after,
+nav.contents::after,
+aside.topic::after,
 div.topic::after,
 div.admonition::after,
 blockquote::after {
@@ -608,19 +608,27 @@ ol.simple p,
 ul.simple p {
     margin-bottom: 0;
 }
-dl.footnote > dt,
-dl.citation > dt {
+
+aside.footnote > span,
+div.citation > span {
     float: left;
-    margin-right: 0.5em;
 }
-
-dl.footnote > dd,
-dl.citation > dd {
+aside.footnote > span:last-of-type,
+div.citation > span:last-of-type {
+  padding-right: 0.5em;
+}
+aside.footnote > p {
+  margin-left: 2em;
+}
+div.citation > p {
+  margin-left: 4em;
+}
+aside.footnote > p:last-of-type,
+div.citation > p:last-of-type {
     margin-bottom: 0em;
 }
-
-dl.footnote > dd:after,
-dl.citation > dd:after {
+aside.footnote > p:last-of-type:after,
+div.citation > p:last-of-type:after {
     content: "";
     clear: both;
 }
@@ -636,10 +644,6 @@ dl.field-list > dt {
     padding-left: 0.5em;
     padding-right: 5px;
 }
-dl.field-list > dt:after {
-    content: ":";
-}
-
 
 dl.field-list > dd {
     padding-left: 0.5em;