# shiro-site

**Repository Path**: kedocode/shiro-site

## Basic Information

- **Project Name**: shiro-site
- **Description**: Mirror of Apache Shiro Site
- **Primary Language**: HTML
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-05-24
- **Last Updated**: 2024-06-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Apache Shiro Website Overview

The Apache Shiro website is a static content website accessible at http://shiro.apache.org

Site content is authored as Markdown and HTML files.  These files are scanned by a tool that applies a page template to each file's contents as necessary, and the rendered static .html files are output to a `publish` directory.

Publishing site changes is as simple as committing any changes in the `publish` directory to version control.  ASF infrastructure will see the commit and automatically push the changes to the ASF's production webservers.

## Generating and Publishing

The tool used to generate the static content is [SCMS](https://github.com/lhazlewood/scms).  Once scms is installed and in your `$PATH`, generating and publishing the site on the command line is easy.
 
The following example assumes you have SVN commit permissions to the `publish` directory, typically because your are an Apache Shiro project committer:
    
    cd site
    # This next command will take a few seconds, be patient :)
    scms trunk publish
    # Open up the local publish/index.html file in your web browser.  Ensure the changes reflect what you want. 
    #
    # This next commands will publish changes to live ASF web servers.  Be confident the changes are what you want:
    svn add .
    svn commit -m "my change description"