Skip to content

Commit

Permalink
Updated docs to new syntax of mkdocs and rtfd
Browse files Browse the repository at this point in the history
  • Loading branch information
hugsy committed Oct 22, 2019
1 parent acced86 commit 1a188d4
Show file tree
Hide file tree
Showing 6 changed files with 28 additions and 6 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@ tests/pylint.html
tests/pylint.txt
tests/pylint3.html
.vscode
_build
19 changes: 19 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# .readthedocs.yml
#
# Reference: https://docs.readthedocs.io/en/stable/config-file/v2.html


version: 2

mkdocs:
configuration: mkdocs.yml

formats: all

build:
image: latest

python:
version: 3.7
install:
- requirements: ./requirements.txt
2 changes: 1 addition & 1 deletion docs/commands/checksec.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## Command checksec ##

The `checksec` command is inspired from
[`checksec.sh`](www.trapkit.de/tools/checksec.html). It provides a
[`checksec.sh`](http://www.trapkit.de/tools/checksec.html). It provides a
convenient way to determine which security protections are enabled in a binary.

You can use the command on the currently debugged process:
Expand Down
2 changes: 1 addition & 1 deletion docs/commands/scan.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ belonging to another (needle).

`scan` requires two arguments, the first is the memory section that will be
searched and the second is what will be searched for. The arguments are grepped
against the processes memory mappings (just like [vmmap](docs/commands/vmmap.md)
against the processes memory mappings (just like [vmmap](./vmmap.md)
to determine the memory ranges to search.

To check mappings without a path associated, an address range (start-end) can be used.
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ distros start pushing `gdb` compiled with Python3 support).
* Suited for real-life apps debugging, exploit development, just as much as
CTF (unlike _PEDA_ or _PwnDBG_)

Check out the [Screenshot page](docs/screenshots.md) for more.
Check out the [Screenshot page](./screenshots.md) for more.


## Setup ##
Expand Down
8 changes: 5 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
site_name: GEF - GDB Enhanced Features documentation
theme: readthedocs
pages:
nav:
- Home: index.md
- Configuration: config.md
- Frequently Asked Questions: faq.md
Expand All @@ -23,13 +23,15 @@ pages:
- Command format-string-helper: commands/format-string-helper.md
- Command functions: commands/functions.md
- Command gef-remote: commands/gef-remote.md
- Command heap: commands/heap.md
- Command got: commands/got.md
- Command heap-analysis-helper: commands/heap-analysis-helper.md
- Command heap: commands/heap.md
- Command help: commands/help.md
- Command hexdump: commands/hexdump.md
- Command highlight: commands/highlight.md
- Command hijack-fd: commands/hijack-fd.md
- Command ida-interact: commands/ida-interact.md
- Command is-syscall: commands/is-syscall.md
- Command ksymaddr: commands/ksymaddr.md
- Command memory: commands/memory.md
- Command name-break: commands/name-break.md
Expand All @@ -49,6 +51,7 @@ pages:
- Command set-permission: commands/set-permission.md
- Command shellcode: commands/shellcode.md
- Command stub: commands/stub.md
- Command syscall-args: commands/syscall-args.md
- Command theme: commands/theme.md
- Command tmux-setup: commands/tmux-setup.md
- Command trace-run: commands/trace-run.md
Expand All @@ -57,4 +60,3 @@ pages:
- Command xfiles: commands/xfiles.md
- Command xinfo: commands/xinfo.md
- Command xor-memory: commands/xor-memory.md
- Command got: commands/got.md

0 comments on commit 1a188d4

Please sign in to comment.