Giter VIP home page Giter VIP logo

pentest-cheatsheets's Introduction

Penetration Testing Guide

Getting Started

Install sphinx and the "Read The Docs" theme:

$ pip install sphinx sphinx_rtd_theme

Contributing

I've tried to stick to a layout throughout (early on I did not, if you see pages that don't match the style I'm about to describe, feel free to fix them).

Section Headings

The page title should be at the top of the page and use the following syntax. Note that the #'s must appear above and below the title, and must span the width of the title.

##########
Page Title
##########

Sections, subsections, etc use a similar syntax, but do not require an overline:

Section
=======

Subsection
----------

Subsubsection
^^^^^^^^^^^^^

If anything lower than the subsubsection is required, it is suggested that bold text is used.

Code Examples

Code blocks can be placed like so:

.. code-block:: bash

    code goes here

If possible, avoid showing prompt characters (e.g. $, #, or C:>) unless necessary for the example.

For inline code, use:

:code:`inline code goes here`

Additional Markup

There is a very useful basic guide to Sphinx/reStructuredText here: http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html

Compiling

How to compile after making alterations:

$ pip install sphinx sphinx_rtd_theme
$ make clean && make html

The compiled html will be in the _build directory.

pentest-cheatsheets's People

Contributors

tib3rius avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.