Skip to content

Commit ed558f5

Browse files
seladbseladb
committed
Initial commit
0 parents  commit ed558f5

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

87 files changed

+11239
-0
lines changed

‎.gitignore

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Jekyll
2+
_site/
3+
.sass-cache/
4+
.jekyll-cache/
5+
.jekyll-metadata
6+
Gemfile.lock
7+
jekyll.bat
8+
jekyll.sh
9+
10+
# Visual studio code
11+
.cproject
12+
.project
13+
.vscode
14+
15+
# doxygen
16+
api-docs/html

‎404.html

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
layout: generic-page
3+
---
4+
5+
<style type="text/css" media="screen">
6+
.container {
7+
margin: 10px auto;
8+
max-width: 600px;
9+
text-align: center;
10+
}
11+
h1 {
12+
margin: 30px 0;
13+
font-size: 4em;
14+
line-height: 1;
15+
letter-spacing: -1px;
16+
}
17+
</style>
18+
19+
<div class="container">
20+
<h1>404</h1>
21+
22+
<h2><strong>Page not found :(</strong></h1>
23+
<p>We couldn't find what you were looking for.</p>
24+
</div>

‎Gemfile

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
source "https://rubygems.org"
2+
3+
# Hello! This is where you manage which Jekyll version is used to run.
4+
# When you want to use a different version, change it below, save the
5+
# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
6+
#
7+
# bundle exec jekyll serve
8+
#
9+
# This will help ensure the proper Jekyll version is running.
10+
# Happy Jekylling!
11+
gem "jekyll", "~> 3.8.5"
12+
13+
# This is the default theme for new Jekyll sites. You may change this to anything you like.
14+
gem "minima", "~> 2.0"
15+
16+
# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
17+
# uncomment the line below. To upgrade, run `bundle update github-pages`.
18+
# gem "github-pages", group: :jekyll_plugins
19+
20+
# If you have any plugins, put them here!
21+
group :jekyll_plugins do
22+
gem "jekyll-feed", "~> 0.6"
23+
end
24+
25+
# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
26+
gem "tzinfo-data", platforms: [:mingw, :mswin, :x64_mingw, :jruby]
27+
28+
# Performance-booster for watching directories on Windows
29+
gem "wdm", "~> 0.1.0" if Gem.win_platform?
30+
31+
# Just The Docs theme
32+
# gem "just-the-docs"
33+
34+
# Remote theme gem use modified verison of Just The Docs theme
35+
gem "jekyll-remote-theme"
36+
37+
# Create a sitemap
38+
gem "jekyll-sitemap"
39+
40+
gem "rake"
41+

‎README.md

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
[![PcapPlusPlus Logo](/resources/logo_color.png)](https://pcapplusplus.github.io)
2+
3+
[PcapPlusPlus](https://pcapplusplus.github.io) is a multiplatform C++ library for capturing, parsing and crafting of network packets. It is designed to be efficient, powerful and easy to use.
4+
5+
PcapPlusPlus enables decoding and forging capabilities for a large variety of network protocols. It also provides easy to use C++ wrappers for the most popular packet processing engines such as [libpcap](https://www.tcpdump.org/), [WinPcap](https://www.winpcap.org/), [DPDK](https://www.dpdk.org/) and [PF_RING](https://www.ntop.org/products/packet-capture/pf_ring/).
6+
7+
This repo contains the content for [PcapPlusPlus web-site](https://pcapplusplus.github.io).
8+
9+
The project itself can be found here: <https://github.com/seladb/PcapPlusPlus>
10+
11+
## Getting Started
12+
13+
### Prerequisites
14+
15+
1. Git
16+
2. [Jekyll](https://jekyllrb.com/docs/installation/)
17+
18+
### Running locally
19+
20+
1. Clone this repo: `git clone https://github.com/PcapPlusPlus/pcapplusplus.github.io.git`
21+
2. Run the web-site using Bundler: `bundle exec jekyll serve`
22+
3. Browse to `http://localhost:4000`
23+
24+
## Overview
25+
26+
This web-site is built using [Jekyll](https://jekyllrb.com/) and uses [Just The Docs](https://pmarsceill.github.io/just-the-docs/) theme for most of its content.
27+
28+
The API reference is generated using [Doxygen](http://www.doxygen.nl/). The Doxygen files are located under the `/api-docs/doxygen` directory and include the `Doxyfile` file and `mainpage.dox` which is the API main page.
29+
30+
Most of the content is organized in Markdown (.md) files which are easy to generate and maintain. The only exceptions are the API reference pages (which are generated using Doxygen) and the Landing Page (`index.html`).
31+
32+
## Contribute
33+
34+
You are more than welcome to contribute to this web-site. You can do that by either opening [issues on GitHub](https://github.com/PcapPlusPlus/pcapplusplus.github.io/issues) or by adding/modifying content and create a PR.
35+
36+
If you don't have a GitHub user you can also contact us by email: <mailto:[email protected]>
37+
38+
If you decide to create a PR please make sure you:
39+
40+
- Run the changes locally to make sure they're working. Please refer to the [Getting Started](#getting-started) section to learn how
41+
- Test the changes on different browsers
42+
- Test the changes on both desktop and mobile. You don't really have to run it on a mobile device, each desktop browser offers a mobile view of the page

‎_config.yml

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
title: PcapPlusPlus
2+
email: [email protected]
3+
description: A multiplatform C++ library for capturing, parsing and crafting of network packets. It is designed to be efficient, powerful and easy to use
4+
baseurl: "" # the subpath of your site, e.g. /blog
5+
url: "https://pcapplusplus.github.io"
6+
twitter_username: seladb
7+
github_username: seladb
8+
logo_source: /resources/logo_white.png
9+
logo_width: 180
10+
11+
# Build settings
12+
markdown: kramdown
13+
remote_theme: seladb/just-the-docs
14+
plugins:
15+
- jekyll-seo-tag
16+
- jekyll-feed
17+
- jekyll-remote-theme
18+
- jekyll-sitemap
19+
20+
# Enable or disable the site search
21+
search_enabled: true
22+
23+
# Enable or disable top navigation panel
24+
top_navigation_enabled: true
25+
26+
# PcapPlusPlus specific variables
27+
pcapplusplus_ver_num: 20.08
28+
pcapplusplus_ver: v20.08
29+
is_new_release: false
30+
31+
# Google Analytics Tracking Id
32+
ga_tracking: UA-74037205-2
33+
34+
include:
35+
- _*_8h.html
36+
- _*_8h_source.html
37+
- _*_8h.js
38+
39+
exclude:
40+
- /api-docs/doxygen/
41+
- /api-docs/html/
42+
- README.md
43+

‎_data/top_navigation.yml

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
left_items:
2+
- name: Docs
3+
link: /docs/
4+
external_link: false
5+
- name: Features
6+
link: /docs/features
7+
external_link: false
8+
- name: API
9+
link: /docs/api
10+
external_link: false
11+
- name: Community
12+
link: /docs/community
13+
external_link: false
14+
15+
right_items:
16+
- name: GitHub
17+
tooltip: PcapPlusPlus on GitHub
18+
image: /resources/logo-github-invert.png
19+
link: https://github.com/seladb/PcapPlusPlus
20+
- name: Twitter
21+
tooltip: PcapPlusPlus on Twitter
22+
image: /resources/logo-twitter.png
23+
link: https://twitter.com/seladb
24+
- name: StackOverflow
25+
tooltip: PcapPlusPlus tag on Stack Overflow
26+
image: /resources/Stack_Overflow_icon.png
27+
link: https://stackoverflow.com/questions/tagged/pcapplusplus
28+
- name: Email
29+
tooltip: Send us an Email
30+
image: /resources/logo-email.png
31+
link: mailto:[email protected]
32+
- name: Google Group
33+
tooltip: PcapPlusPlus Google Group
34+
image: /resources/logo-google.png
35+
link: https://groups.google.com/d/forum/pcapplusplus-support

‎_includes/new-release.html

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{% if site.is_new_release != nil and site.is_new_release == true %}
2+
<img src="{{ site.baseurl }}/resources/new-icon.png" alt="drawing" width="64" title="New Release!"/>
3+
{% endif %}

‎_sass/code.scss

+101
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
/* Dracula Theme v1.2.5
2+
*
3+
* https://github.com/zenorocha/dracula-theme
4+
*
5+
* Copyright 2016, All rights reserved
6+
*
7+
* Code licensed under the MIT license
8+
* http://zenorocha.mit-license.org
9+
*
10+
* @author Rob G <[email protected]>
11+
* @author Chris Bracco <[email protected]>
12+
* @author Zeno Rocha <[email protected]>
13+
*/
14+
15+
code.highlighter-rouge {
16+
margin-bottom: .75rem;
17+
overflow: hidden;
18+
border-radius: 4px;
19+
padding: 0.2em 0.15em;
20+
font-weight: 400;
21+
background-color: #e1e3ec;
22+
border: 1px solid #eeebee;
23+
}
24+
25+
.highlight .hll { background-color: #f1fa8c }
26+
.highlight { background: #282a36; color: #f8f8f2 }
27+
.highlight .c { color: #6272a4 } /* Comment */
28+
.highlight .err { color: #f8f8f2 } /* Error */
29+
.highlight .g { color: #f8f8f2 } /* Generic */
30+
.highlight .k { color: #ff79c6 } /* Keyword */
31+
.highlight .l { color: #f8f8f2 } /* Literal */
32+
.highlight .n { color: #f8f8f2 } /* Name */
33+
.highlight .o { color: #ff79c6 } /* Operator */
34+
.highlight .x { color: #f8f8f2 } /* Other */
35+
.highlight .p { color: #f8f8f2 } /* Punctuation */
36+
.highlight .ch { color: #6272a4 } /* Comment.Hashbang */
37+
.highlight .cm { color: #6272a4 } /* Comment.Multiline */
38+
.highlight .cp { color: #ff79c6 } /* Comment.Preproc */
39+
.highlight .cpf { color: #6272a4 } /* Comment.PreprocFile */
40+
.highlight .c1 { color: #6272a4 } /* Comment.Single */
41+
.highlight .cs { color: #6272a4 } /* Comment.Special */
42+
.highlight .gd { color: #8b080b } /* Generic.Deleted */
43+
.highlight .ge { color: #f8f8f2; text-decoration: underline } /* Generic.Emph */
44+
.highlight .gr { color: #f8f8f2 } /* Generic.Error */
45+
.highlight .gh { color: #f8f8f2; font-weight: bold } /* Generic.Heading */
46+
.highlight .gi { color: #f8f8f2; font-weight: bold } /* Generic.Inserted */
47+
.highlight .go { color: #44475a } /* Generic.Output */
48+
.highlight .gp { color: #f8f8f2 } /* Generic.Prompt */
49+
.highlight .gs { color: #f8f8f2 } /* Generic.Strong */
50+
.highlight .gu { color: #f8f8f2; font-weight: bold } /* Generic.Subheading */
51+
.highlight .gt { color: #f8f8f2 } /* Generic.Traceback */
52+
.highlight .kc { color: #ff79c6 } /* Keyword.Constant */
53+
.highlight .kd { color: #8be9fd; font-style: italic } /* Keyword.Declaration */
54+
.highlight .kn { color: #ff79c6 } /* Keyword.Namespace */
55+
.highlight .kp { color: #ff79c6 } /* Keyword.Pseudo */
56+
.highlight .kr { color: #ff79c6 } /* Keyword.Reserved */
57+
.highlight .kt { color: #8be9fd } /* Keyword.Type */
58+
.highlight .ld { color: #f8f8f2 } /* Literal.Date */
59+
.highlight .m { color: #bd93f9 } /* Literal.Number */
60+
.highlight .s { color: #f1fa8c } /* Literal.String */
61+
.highlight .na { color: #50fa7b } /* Name.Attribute */
62+
.highlight .nb { color: #8be9fd; font-style: italic } /* Name.Builtin */
63+
.highlight .nc { color: #50fa7b } /* Name.Class */
64+
.highlight .no { color: #f8f8f2 } /* Name.Constant */
65+
.highlight .nd { color: #f8f8f2 } /* Name.Decorator */
66+
.highlight .ni { color: #f8f8f2 } /* Name.Entity */
67+
.highlight .ne { color: #f8f8f2 } /* Name.Exception */
68+
.highlight .nf { color: #50fa7b } /* Name.Function */
69+
.highlight .nl { color: #8be9fd; font-style: italic } /* Name.Label */
70+
.highlight .nn { color: #f8f8f2 } /* Name.Namespace */
71+
.highlight .nx { color: #f8f8f2 } /* Name.Other */
72+
.highlight .py { color: #f8f8f2 } /* Name.Property */
73+
.highlight .nt { color: #ff79c6 } /* Name.Tag */
74+
.highlight .nv { color: #8be9fd; font-style: italic } /* Name.Variable */
75+
.highlight .ow { color: #ff79c6 } /* Operator.Word */
76+
.highlight .w { color: #f8f8f2 } /* Text.Whitespace */
77+
.highlight .mb { color: #bd93f9 } /* Literal.Number.Bin */
78+
.highlight .mf { color: #bd93f9 } /* Literal.Number.Float */
79+
.highlight .mh { color: #bd93f9 } /* Literal.Number.Hex */
80+
.highlight .mi { color: #bd93f9 } /* Literal.Number.Integer */
81+
.highlight .mo { color: #bd93f9 } /* Literal.Number.Oct */
82+
.highlight .sa { color: #f1fa8c } /* Literal.String.Affix */
83+
.highlight .sb { color: #f1fa8c } /* Literal.String.Backtick */
84+
.highlight .sc { color: #f1fa8c } /* Literal.String.Char */
85+
.highlight .dl { color: #f1fa8c } /* Literal.String.Delimiter */
86+
.highlight .sd { color: #f1fa8c } /* Literal.String.Doc */
87+
.highlight .s2 { color: #f1fa8c } /* Literal.String.Double */
88+
.highlight .se { color: #f1fa8c } /* Literal.String.Escape */
89+
.highlight .sh { color: #f1fa8c } /* Literal.String.Heredoc */
90+
.highlight .si { color: #f1fa8c } /* Literal.String.Interpol */
91+
.highlight .sx { color: #f1fa8c } /* Literal.String.Other */
92+
.highlight .sr { color: #f1fa8c } /* Literal.String.Regex */
93+
.highlight .s1 { color: #f1fa8c } /* Literal.String.Single */
94+
.highlight .ss { color: #f1fa8c } /* Literal.String.Symbol */
95+
.highlight .bp { color: #f8f8f2; font-style: italic } /* Name.Builtin.Pseudo */
96+
.highlight .fm { color: #50fa7b } /* Name.Function.Magic */
97+
.highlight .vc { color: #8be9fd; font-style: italic } /* Name.Variable.Class */
98+
.highlight .vg { color: #8be9fd; font-style: italic } /* Name.Variable.Global */
99+
.highlight .vi { color: #8be9fd; font-style: italic } /* Name.Variable.Instance */
100+
.highlight .vm { color: #8be9fd; font-style: italic } /* Name.Variable.Magic */
101+
.highlight .il { color: #bd93f9 } /* Literal.Number.Integer.Long */

0 commit comments

Comments
 (0)