Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
47 commits
Select commit Hold shift + click to select a range
671faf5
Set theme jekyll-theme-merlot
KCarretto Feb 24, 2022
3290bd4
Create index.md
KCarretto Feb 24, 2022
99b283e
Attempt to override theme
KCarretto Feb 24, 2022
f246ee0
Attempt to fix width
KCarretto Feb 24, 2022
9e7f13b
Another try
KCarretto Feb 24, 2022
8a129c3
Again
KCarretto Feb 24, 2022
9a40b03
try a %
KCarretto Feb 24, 2022
37ac74b
Trying new template without jekyyl
KCarretto Feb 24, 2022
33d32c7
Added some test content
KCarretto Feb 24, 2022
07b63e0
Delete sample info
KCarretto Feb 24, 2022
9f2c846
Updated title
KCarretto Feb 24, 2022
4e8fafa
Added sample functions
KCarretto Feb 24, 2022
9736e00
Added more sample functions
KCarretto Feb 24, 2022
ec935f1
Fix path
KCarretto Feb 24, 2022
f9e8b39
File -> File Library etc.
KCarretto Feb 24, 2022
c75b2e1
Attempt to updated sidebar
KCarretto Feb 24, 2022
a1a556f
Test reintegrating jekyll
KCarretto Feb 24, 2022
cc28d62
Attempt to use _data and _includes for site nav
KCarretto Feb 24, 2022
9934474
Fix CSS
KCarretto Feb 24, 2022
11a20f0
Attempt to jekyll page nav
KCarretto Feb 24, 2022
f4f21b8
Added nav item
KCarretto Feb 24, 2022
2bd4cb9
Maybe Jekyll was broken?
KCarretto Feb 24, 2022
53fd5c3
Fix Jekyll
KCarretto Feb 24, 2022
189fdbc
Fix Dark Mode
KCarretto Feb 24, 2022
1a9149e
Attempted to make you some content
KCarretto Feb 25, 2022
2193d18
Oh goodie more jekyll errors
KCarretto Feb 25, 2022
4ddf335
Fix issue
KCarretto Feb 25, 2022
809a4cb
Adjusted heading size
KCarretto Feb 25, 2022
00dc8a3
Attempting to play with stuff
KCarretto Feb 25, 2022
433e4d3
Testing something
KCarretto Feb 25, 2022
a0e88e1
This seems safe
KCarretto Feb 25, 2022
a9ce6b8
yep cool
KCarretto Feb 25, 2022
8cad8aa
fixed spacing
KCarretto Feb 25, 2022
57778f1
Attempting to fix some of the nav
KCarretto Feb 25, 2022
76288f9
Added image
KCarretto Feb 25, 2022
39f7fc4
Attempting to reposition images
KCarretto Feb 25, 2022
1897f6a
More css magic from catie :)
KCarretto Feb 25, 2022
483d9aa
Push to prod
KCarretto Feb 25, 2022
a42d925
Catie test
KCarretto Feb 25, 2022
2037f2b
Added the stdlib methods
KCarretto Feb 25, 2022
bc6b045
Fix indent
KCarretto Feb 25, 2022
8fe16b4
Updated logo and added more stuff
KCarretto Feb 25, 2022
47a7f88
Create CNAME
KCarretto Feb 25, 2022
f1446d2
Some minor updates
KCarretto Feb 25, 2022
5969598
Merge branch 'docs' of github.com:KCarretto/realm into docs
KCarretto Feb 25, 2022
6c55e5a
Fix bad js
KCarretto Feb 25, 2022
396fc42
Fix offset
KCarretto Feb 25, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions docs/.gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Auto detect text files and perform LF normalization
* text=auto

# Custom for Visual Studio
*.cs diff=csharp

# Standard to msysgit
*.doc diff=astextplain
*.DOC diff=astextplain
*.docx diff=astextplain
*.DOCX diff=astextplain
*.dot diff=astextplain
*.DOT diff=astextplain
*.pdf diff=astextplain
*.PDF diff=astextplain
*.rtf diff=astextplain
*.RTF diff=astextplain
7 changes: 7 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Ruby
Gemfile
Gemfile.lock

# Jekyll
.jekyll-cache
_site
1 change: 1 addition & 0 deletions docs/CNAME
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
docs.realm.pub
2 changes: 2 additions & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
title: Realm
description: Realm Documentation
108 changes: 108 additions & 0 deletions docs/_data/eldritch_nav.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
- name: Overview
link: overview
content: Eldritch is a Pythonic-DSL for Red Team Implants.
- name: Standard Library
link: stdlib
content: The Standard Library is very cool, and will be even cooler when Nick documents it.
subnav:
- name: File Library
link: stdlib_file
content: The File Library is very cool, and will be even cooler when Nick documents it.
subnav:
- name: "file.append"
signature: "file.append(path: str, content: str) -> None"
link: stdlib_file_append
content: The <b>file.append</b> method is very cool, and will be even cooler when Nick documents it.
- name: "file.copy"
signature: "file.copy(src: str, dst: str) -> None"
link: stdlib_file_copy
content: The <b>file.copy</b> method is very cool, and will be even cooler when Nick documents it.
- name: "file.download"
signature: "file.download(uri: str, dst: str) -> None"
link: stdlib_file_download
content: The <b>file.download</b> method is very cool, and will be even cooler when Nick documents it.
- name: "file.exists"
signature: "file.exists(path: str) -> bool"
link: stdlib_file_exists
content: The <b>file.exists</b> method is very cool, and will be even cooler when Nick documents it.
- name: "file.hash"
signature: "file.hash(path: str) -> str"
link: stdlib_file_hash
content: The <b>file.hash</b> method is very cool, and will be even cooler when Nick documents it.
- name: "file.is_dir"
signature: "file.is_dir(path: str) -> bool"
link: stdlib_file_is_dir
content: The <b>file.is_dir</b> method is very cool, and will be even cooler when Nick documents it.
- name: "file.mkdir"
signature: "file.mkdir(path: str) -> None"
link: stdlib_file_mkdir
content: The <b>file.mkdir</b> method is very cool, and will be even cooler when Nick documents it.
- name: "file.read"
signature: "file.read(path: str) -> str"
link: stdlib_file_read
content: The <b>file.read</b> method is very cool, and will be even cooler when Nick documents it.
- name: "file.remove"
signature: "file.remove(path: str) -> None"
link: stdlib_file_remove
content: The <b>file.remove</b> method is very cool, and will be even cooler when Nick documents it.
- name: "file.rename"
signature: "file.rename(src: str, dst: str) -> None"
link: stdlib_file_rename
content: The <b>file.rename</b> method is very cool, and will be even cooler when Nick documents it.
- name: "file.replace"
signature: "file.replace(path: str, pattern: str, value: str) -> None"
link: stdlib_file_replace
content: The <b>file.replace</b> method is very cool, and will be even cooler when Nick documents it.
- name: "file.replace_all"
signature: "file.replace_all(path: str, pattern: str, value: str) -> None"
link: stdlib_file_replace_all
content: The <b>file.replace_all</b> method is very cool, and will be even cooler when Nick documents it.
- name: "file.timestomp"
signature: "file.timestomp(src: str, dst: str) -> None"
link: stdlib_file_timestomp
content: The <b>file.timestomp</b> method is very cool, and will be even cooler when Nick documents it.
- name: "file.write"
signature: "file.write(path: str, content: str) -> None"
link: stdlib_file_write
content: The <b>file.write</b> method is very cool, and will be even cooler when Nick documents it.
- name: Process Library
link: stdlib_process
content: The Process Library is very cool, and will be even cooler when Nick documents it.
subnav:
- name: "process.kill"
signature: "process.kill(pid: int) -> None"
link: stdlib_process_kill
content: The <b>process.kill</b> method is very cool, and will be even cooler when Nick documents it.
- name: "process.list"
signature: "process.list() -> List<int>"
link: stdlib_process_list
content: The <b>process.list</b> method is very cool, and will be even cooler when Nick documents it.
- name: "process.name"
signature: "process.name(pid: int) -> str"
link: stdlib_process_name
content: The <b>process.name</b> method is very cool, and will be even cooler when Nick documents it.
- name: Sys Library
link: stdlib_sys
content: The Sys Library is very cool, and will be even cooler when Nick documents it.
subnav:
- name: "sys.exec"
signature: "sys.exec(path: str, args: List<str>, ?disown: bool) -> str"
link: stdlib_sys_exec
content: The <b>sys.exec</b> method is very cool, and will be even cooler when Nick documents it.
- name: "sys.is_linux"
signature: "sys.is_linux() -> bool"
link: stdlib_sys_is_linux
content: The <b>sys.is_linux</b> method is very cool, and will be even cooler when Nick documents it.
- name: "sys.is_windows"
signature: "sys.is_windows() -> bool"
link: stdlib_sys_is_windows
content: The <b>sys.is_windows</b> method is very cool, and will be even cooler when Nick documents it.
- name: "sys.shell"
signature: "sys.shell(cmd: str) -> str"
link: stdlib_sys_shell
content: The <b>sys.shell</b> method is very cool, and will be even cooler when Nick documents it.

- name: Dev Docs
link: dev
content: I'm sure Nick would love help developing the language, but until he finishes this documentation he probably won't receive any.

4 changes: 4 additions & 0 deletions docs/_data/site_nav.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
- name: Home
link: /realm
- name: Eldritch
link: /realm/eldritch
63 changes: 63 additions & 0 deletions docs/_includes/eldritch_content.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
{% for item in site.data.eldritch_nav %}
<div class="row">
<div class="col-md-12">
<h1 id="{{ item.link }}">{{ item.name }}<hr/></h1>
</div>
<!-- end col -->
</div>
{% if item.content != nil %}
<!-- end row -->
<div class="row">
<div class="col-md-12">
<p>{{ item.content }}</p>
</div>
<!-- end col -->
</div>
<!-- end row -->
{% endif %}

{% if item.subnav != nil %}
{% for subitem in item.subnav %}
<div class="row">
<div class="col-md-12">
<h2 id="{{ subitem.link }}">{{ subitem.name }}</h2>
</div>
<!-- end col -->
</div>
<!-- end row -->
{% if subitem.content != nil %}
<div class="row">
<div class="col-md-12">
<p>{{ subitem.content }}</p>
</div>
<!-- end col -->
</div>
<!-- end row -->
{% endif %}

{% if subitem.subnav != nil %}
{% for subsubitem in subitem.subnav %}
<div class="row">
<div class="col-md-12">
<b id="{{ subsubitem.link }}">{{ subsubitem.name }}</b>
</div>
<!-- end col -->
</div>
<!-- end row -->
{% if subsubitem.content != nil %}
<div class="row">
<div class="col-md-12">
{% if subsubitem.signature != nil %}
<code class="code">{{ subsubitem.signature }}</code>
{% endif %}
<p>{{ subsubitem.content }}</p>
</div>
<!-- end col -->
</div>
{% endif %}
<!-- end row -->
{% endfor %}
{% endif %}
{% endfor %}
{% endif %}
{% endfor %}
28 changes: 28 additions & 0 deletions docs/_includes/eldritch_nav.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<nav class="page-sidebar" data-spy="affix" data-offset-top="300" data-offset-bottom="200" role="navigation">
<ul class="nav">
{% for item in site.data.eldritch_nav %}
<li><a href="#{{ item.link }}">{{ item.name }}</a>

{% if item.subnav != nil %}
<ul class="nav">


{% for subitem in item.subnav %}
<li><a href="#{{ subitem.link }}" >{{ subitem.name }}</a>
{% if subitem.subnav != nil %}
<ul class="nav">
{% for subsubitem in subitem.subnav %}
<li><a href="#{{ subsubitem.link }}">{{ subsubitem.name }}</a></li>
{% endfor %}
</ul>
{% endif %}
</li>
{% endfor %}


</ul>
{% endif %}
</li>
{% endfor %}
</ul>
</nav >
7 changes: 7 additions & 0 deletions docs/_includes/site_nav.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<nav class="site-sidebar" data-spy="affix" data-offset-top="300" data-offset-bottom="200" role="navigation">
<ul class="nav">
{% for item in site.data.site_nav %}
<li><a href="{{ item.link }}">{{ item.name }}</a></li>
{% endfor %}
</ul>
</nav >
Loading