Add BlackSheep v1

Author: RobertoPrevato

.gitignore

@@ -6,3 +6,5 @@ site.zip
 
 # temporary
 rodi
+shared-assets
+copy-shared.sh

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Neoteroi, Roberto Prevato (roberto.prevato@gmail.com)
+Copyright (c) 2021 Roberto Prevato (roberto.prevato@gmail.com)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -12,8 +12,8 @@ The code has been modified to unify different projects.
 
 ## How to contribute
 
-The documentation uses MkDocs. For information on how to use MkDocs, refer to its
-documentation.
+The documentation uses MkDocs and Material for MkDocs. For information on how
+to use these tools, refer to their documentation.
 
 ```bash
 $ mkdocs serve

blacksheep/archive/README.md

@@ -0,0 +1,4 @@
+# Archived documentation
+
+This folder contains archived documentation of the web framework, not meant
+to be updated.

blacksheep/archive/v1.7z

@@ -0,0 +1,6 @@
+#! /bin/bash
+
+# This file expects an existing ./site folder created using MkDocs build.
+# It unzips archives of older versions of the documentation into the site
+# folder.
+7z x -o"site/v1" archive/v1.7z

blacksheep/copy-archive.sh

@@ -16,13 +16,13 @@ pip install blacksheep
 ## BlackSheep offers...
 
 - A rich code API, based on dependency injection and inspired by Flask and
-  ASP.NET Core
+  ASP.NET Core.
 - A typing-friendly codebase, which enables a comfortable development
-  experience thanks to hints when coding with IDEs
+  experience thanks to hints when coding with IDEs.
 - Built-in generation of OpenAPI Documentation, supporting version 3, YAML, and
-  JSON
-- A cross-platform framework, using the most modern versions of Python
-- Good performance
+  JSON.
+- A cross-platform framework, using the most modern versions of Python.
+- Good performance.
 
 ## Getting started
 

blacksheep/docs/index.md

@@ -16,6 +16,13 @@ for folder in "${folders[@]}" ; do
 
     mkdocs build
 
+    # check if there is a copy-archive.sh file, to support including docs
+    # of older versions of the library
+    if [ -f "copy-archive.sh" ]; then
+        echo "File $FILE exists."
+        ./copy-archive.sh
+    fi
+
     mv site/* ../site/$folder
     rm -rf site
     cd ../