Skip to content
This repository has been archived by the owner on Jul 6, 2024. It is now read-only.

Commit

Permalink
First commit ❤️
Browse files Browse the repository at this point in the history
  • Loading branch information
hahwul committed Nov 11, 2023
1 parent 30cb525 commit 80cfa57
Show file tree
Hide file tree
Showing 17 changed files with 442 additions and 0 deletions.
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
_site
.sass-cache
.jekyll-cache
.jekyll-metadata
vendor
25 changes: 25 additions & 0 deletions 404.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
permalink: /404.html
layout: default
---

<style type="text/css" media="screen">
.container {
margin: 10px auto;
max-width: 600px;
text-align: center;
}
h1 {
margin: 30px 0;
font-size: 4em;
line-height: 1;
letter-spacing: -1px;
}
</style>

<div class="container">
<h1>404</h1>

<p><strong>Page not found :(</strong></p>
<p>The requested page could not be found.</p>
</div>
15 changes: 15 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
source "https://rubygems.org"

gem "jekyll", "~> 4.3.2"
gem "just-the-docs"
group :jekyll_plugins do
gem "jekyll-feed", "~> 0.12"
end

platforms :mingw, :x64_mingw, :mswin, :jruby do
gem "tzinfo", ">= 1", "< 3"
gem "tzinfo-data"
end

gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]
gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby]
93 changes: 93 additions & 0 deletions Gemfile.lock
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
GEM
remote: https://rubygems.org/
specs:
addressable (2.8.5)
public_suffix (>= 2.0.2, < 6.0)
colorator (1.1.0)
concurrent-ruby (1.2.2)
em-websocket (0.5.3)
eventmachine (>= 0.12.9)
http_parser.rb (~> 0)
eventmachine (1.2.7)
ffi (1.16.3)
forwardable-extended (2.6.0)
google-protobuf (3.25.0-arm64-darwin)
http_parser.rb (0.8.0)
i18n (1.14.1)
concurrent-ruby (~> 1.0)
jekyll (4.3.2)
addressable (~> 2.4)
colorator (~> 1.0)
em-websocket (~> 0.5)
i18n (~> 1.0)
jekyll-sass-converter (>= 2.0, < 4.0)
jekyll-watch (~> 2.0)
kramdown (~> 2.3, >= 2.3.1)
kramdown-parser-gfm (~> 1.0)
liquid (~> 4.0)
mercenary (>= 0.3.6, < 0.5)
pathutil (~> 0.9)
rouge (>= 3.0, < 5.0)
safe_yaml (~> 1.0)
terminal-table (>= 1.8, < 4.0)
webrick (~> 1.7)
jekyll-feed (0.17.0)
jekyll (>= 3.7, < 5.0)
jekyll-include-cache (0.2.1)
jekyll (>= 3.7, < 5.0)
jekyll-sass-converter (3.0.0)
sass-embedded (~> 1.54)
jekyll-seo-tag (2.8.0)
jekyll (>= 3.8, < 5.0)
jekyll-watch (2.2.1)
listen (~> 3.0)
just-the-docs (0.7.0)
jekyll (>= 3.8.5)
jekyll-include-cache
jekyll-seo-tag (>= 2.0)
rake (>= 12.3.1)
kramdown (2.4.0)
rexml
kramdown-parser-gfm (1.1.0)
kramdown (~> 2.0)
liquid (4.0.4)
listen (3.8.0)
rb-fsevent (~> 0.10, >= 0.10.3)
rb-inotify (~> 0.9, >= 0.9.10)
mercenary (0.4.0)
minima (2.5.1)
jekyll (>= 3.5, < 5.0)
jekyll-feed (~> 0.9)
jekyll-seo-tag (~> 2.1)
pathutil (0.16.2)
forwardable-extended (~> 2.6)
public_suffix (5.0.3)
rake (13.1.0)
rb-fsevent (0.11.2)
rb-inotify (0.10.1)
ffi (~> 1.0)
rexml (3.2.6)
rouge (4.2.0)
safe_yaml (1.0.5)
sass-embedded (1.69.5-arm64-darwin)
google-protobuf (~> 3.23)
terminal-table (3.0.2)
unicode-display_width (>= 1.1.1, < 3)
unicode-display_width (2.5.0)
webrick (1.8.1)

PLATFORMS
arm64-darwin-22

DEPENDENCIES
http_parser.rb (~> 0.6.0)
jekyll (~> 4.3.2)
jekyll-feed (~> 0.12)
just-the-docs
minima (~> 2.5)
tzinfo (>= 1, < 3)
tzinfo-data
wdm (~> 0.1.1)

BUNDLED WITH
2.4.18
66 changes: 66 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
title: Noir
description: >- # this means to ignore newlines until "baseurl:"
Noir is an attack surface detector form source code.
baseurl: ""
url: ""
github_username: noir-cr

# Build settings
theme: just-the-docs
plugins:
- jekyll-feed

# Exclude from processing.
# The following items will not be processed, by default.
# Any item listed under the `exclude:` key here will be automatically added to
# the internal "default list".
#
# Excluded items can be processed by explicitly listing the directories or
# their entries' file path in the `include:` list.
#
# exclude:
# - .sass-cache/
# - .jekyll-cache/
# - gemfiles/
# - Gemfile
# - Gemfile.lock
# - node_modules/
# - vendor/bundle/
# - vendor/cache/
# - vendor/gems/
# - vendor/ruby/

# Set just the docs

logo: "/assets/images/noir.png"
favicon_ico: "/assets/images/noir.png"
color_scheme: dark

aux_links:
"GitHub":
- "//github.com/noir-cr/noir"

search_enabled: true
search:
# Split pages into sections that can be searched individually
# Supports 1 - 6, default: 2
heading_level: 2
# Maximum amount of previews per search result
# Default: 3
previews: 3
# Maximum amount of words to display before a matched word in the preview
# Default: 5
preview_words_before: 5
# Maximum amount of words to display after a matched word in the preview
# Default: 10
preview_words_after: 10
# Set the search token separator
# Default: /[\s\-/]+/
# Example: enable support for hyphenated search words
tokenizer_separator: /[\s/]+/
# Display the relative url in search results
# Supports true (default) or false
rel_url: true
# Enable or disable the search button that appears in the bottom right corner of every page
# Supports true or false (default)
button: false
29 changes: 29 additions & 0 deletions _posts/2023-11-11-welcome-to-jekyll.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
layout: post
title: "Welcome to Jekyll!"
date: 2023-11-11 16:22:14 +0900
categories: jekyll update
---
You’ll find this post in your `_posts` directory. Go ahead and edit it and re-build the site to see your changes. You can rebuild the site in many different ways, but the most common way is to run `jekyll serve`, which launches a web server and auto-regenerates your site when a file is updated.

Jekyll requires blog post files to be named according to the following format:

`YEAR-MONTH-DAY-title.MARKUP`

Where `YEAR` is a four-digit number, `MONTH` and `DAY` are both two-digit numbers, and `MARKUP` is the file extension representing the format used in the file. After that, include the necessary front matter. Take a look at the source for this post to get an idea about how it works.

Jekyll also offers powerful support for code snippets:

{% highlight ruby %}
def print_hi(name)
puts "Hi, #{name}"
end
print_hi('Tom')
#=> prints 'Hi, Tom' to STDOUT.
{% endhighlight %}

Check out the [Jekyll docs][jekyll-docs] for more info on how to get the most out of Jekyll. File all bugs/feature requests at [Jekyll’s GitHub repo][jekyll-gh]. If you have questions, you can ask them on [Jekyll Talk][jekyll-talk].

[jekyll-docs]: https://jekyllrb.com/docs/home
[jekyll-gh]: https://github.com/jekyll/jekyll
[jekyll-talk]: https://talk.jekyllrb.com/
Binary file added assets/images/noir.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 15 additions & 0 deletions docs/advanced/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
layout: page
title: Advanced
permalink: /advanced/
has_children: true
nav_order: 2
---

Noir is an attack surface detector form source code.

```bash
brew install noir
```


39 changes: 39 additions & 0 deletions docs/contribute/build.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
layout: page
title: Set up Build Environment
permalink: /contribute/build
parent: Contribute
nav_order: 2
---

## Install Crystal
Before getting started with building Noir, you'll need to install Crystal-lang. Refer to the link below for installation guidance.

> https://crystal-lang.org/install/
If you're using macOS or Linux, you can easily install it through Homebrew.

```bash
brew install crystal
```

## Clone noir

```bash
# Clone this repo
git clone https://github.com/noir-cr/noir
cd noir
```

## Build
### Install Dependencies
```bash
shards install
```

### Build
```bash
shards build
```

By default, Crystal builds including debugging information. For release, build with the flags --release --no-debug to exclude debug info.
12 changes: 12 additions & 0 deletions docs/contribute/how_to_contribute.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
layout: page
title: How to Contribute
permalink: /contribute/how-to-contribute
parent: Contribute
nav_order: 1
---

## Install Crystal
```
brew install crystal
```
14 changes: 14 additions & 0 deletions docs/contribute/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
layout: page
title: Contribute
permalink: /contribute/
has_children: true
---

Noir is an attack surface detector form source code.

```bash
brew install noir
```


12 changes: 12 additions & 0 deletions docs/contribute/structure.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
layout: page
title: Struct of Project
permalink: /contribute/structure
parent: Contribute
nav_order: 3
---

## Install Crystal
```
brew install crystal
```
9 changes: 9 additions & 0 deletions docs/get_started/about.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
layout: page
title: What is Noir?
permalink: /get-started/about/
parent: Get Started
nav_order: 1
---

Noir is an attack surface detector form source code.
15 changes: 15 additions & 0 deletions docs/get_started/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
layout: page
title: Get Started
permalink: /get-started/
has_children: true
nav_order: 1
---

Noir is an attack surface detector form source code.

```bash
brew install noir
```


Loading

0 comments on commit 80cfa57

Please sign in to comment.