Skip to content

Commit

Permalink
Add Mkdocs to project
Browse files Browse the repository at this point in the history
  • Loading branch information
praqma-thi committed Nov 11, 2022
1 parent 993670c commit e03a0b4
Show file tree
Hide file tree
Showing 6 changed files with 83 additions and 13 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,6 @@ jfrog-cli-retention-plugin
*.DS_Store

dist/

# Mkdocs
site/
16 changes: 3 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,10 @@
# rt-retention

A JFrog CLI plugin to facilitate artifact retention in Artifactory.
A simple JFrog CLI plugin to facilitate enforcing retention policies in Artifactory.

## TL;DR
The plugin allows you to delete artifacts using [FileSpecs](https://www.jfrog.com/confluence/display/JFROG/Using+File+Specs) found in a given directory.

Deletes artifacts matching all [File Specs](https://www.jfrog.com/confluence/display/JFROG/Using+File+Specs) found in a given directory.

Allows for generation of FileSpecs files through Go templates and a JSON configuration file.

## Installation

This plugin isn't currently hosted anywhere yet, so you'll be building it locally.

You can use the [build.sh](scripts/build.sh) and [install.sh](scripts/install.sh) scripts.

## Usage
It also allows for generation of FileSpecs through Go templates and a JSON configuration file.

### Commands

Expand Down
17 changes: 17 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Welcome to MkDocs

For full documentation visit [mkdocs.org](https://www.mkdocs.org).

## Commands

* `mkdocs new [dir-name]` - Create a new project.
* `mkdocs serve` - Start the live-reloading docs server.
* `mkdocs build` - Build the documentation site.
* `mkdocs -h` - Print help message and exit.

## Project layout

mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.
5 changes: 5 additions & 0 deletions docs/stylesheets/theme.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
:root>* {
--md-primary-fg-color: #ad9ce3;
--md-primary-fg-color--light: #c0b7df;
--md-primary-fg-color--dark: #937cdd;
}
52 changes: 52 additions & 0 deletions mkdocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
site_name: Artifactory Retention
site_url: https://rt-retention.verifa.io
site_description: >-
JFrog CLI plugin for facilitating Artifactory retention policies
# Repository
repo_name: verifa/rt-retention
repo_url: https://github.com/verifa/rt-retention

# Copyright
copyright: Copyright © 2022 Verifa

# Theme
theme:
name: material

font:
text: Outfit
features:
- navigation.indexes
- navigation.sections
- navigation.tabs
- navigation.top
- content.code.annotate
- toc.follow

# Plugins
plugins:
- awesome-pages
- search
- tags

extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/verifa

extra_css:
- stylesheets/theme.css

markdown_extensions:
- admonition
- pymdownx.details
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets:
check_paths: true
- pymdownx.superfences
- meta
- toc:
permalink: true
3 changes: 3 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# MKDocs requirements
mkdocs-material==8.5.9
mkdocs-awesome-pages-plugin

0 comments on commit e03a0b4

Please sign in to comment.