Skip to content

Johannes-Flachberger/hacktricks-obsidian

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1,065 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Hacktricks-Obsidian

This repo fetches contents of HackTricks and HackTricks Cloud and presents them as an obsidian vault. The contents are not edited - only the formatting is transformed to obsidian-flavoured markdown.

For me, this has several advantages over hosting browsing hacktricks online or hosting it locally:

  • more lightweight: no need for running a docker container, building the html sites and a webserver
  • better browsing experience: I think obsidian offers a cleaner browsing experience and search features compared to mdbook.
  • known environment: I build my personal knowledge base in obsidian - its cool to have the hacktricks content available in the same environment.

Usage

  1. Clone the repo
  2. Checkout the main branch
  3. With obsidian, open the /hacktricks-all subfolder as a vault

Alternatively, you can open the repo using vscode - most of the obsidian specific syntax is rendered correctly when using the Foam extension for vscode.

How it works

The master branches of the "upstream" repos are fetched daily. The source files are transformed to obsidian-flavoured markdown and pushed into a unified directory on the main branch using github actions.

License and Attribution

This repository uses contents of HackTricks and HackTricks Cloud by Carlos Polop.
The original work © Carlos Polop 2021 is licensed under the Creative Commons Attribution-NonCommercial 4.0 International License (CC BY-NC 4.0).

My contributions and modifications are shared under the same license.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages