diff --git a/docs/Hacking - Static Site Client.md b/docs/Hacking - Static Site Client.md index 0aeec2b0..cd4ca01f 100644 --- a/docs/Hacking - Static Site Client.md +++ b/docs/Hacking - Static Site Client.md @@ -11,9 +11,9 @@ Please note that this diagram only describes classes created as part of the Stat |Name|Role and description|Dependency summary| |---|---|---| |StaticSiteClient|Serves as the primary interface between Open Live Writer and the Static Site Generator support. Implements Blog functions such as CRUD on posts and pages.|| -|StaticSiteConfig|Defines and handles the storage and processing of configuration settings for the Static Site Generator support.|| +|StaticSiteConfig|Defines and handles the storage and processing of configuration settings for the Static Site Generator support.|| |StaticSiteItem|Abstract class which represents a published or yet-to-be-published generic item to `StaticSiteClient`. Contains methods related to loading and saving, as well as generic methods which are based upon through sub-classes.|| |StaticSitePost|Sub-class of `StaticSiteItem` representing a Post item.|Sub-classes `StaticSiteItem`| |StaticSitePage|Sub-class of `StaticSiteItem` representing a Page item.|Sub-classes `StaticSiteItem`| -|StaticSiteItemFrontMatter|Defines and stores all possible static item front matter keys. Implements loading and saving from YAML, as well as loading and saving from a `OpenLiveWriter.Extensibility.BlogClient.BlogPost` instance.|| -|StaticSiteItemFrontMatterKeys|A subset of the static site config, `StaticSiteItemFrontMatterKeys` contains the key names for each of the supported front-matter attributes. Used to support different static site generators.|| \ No newline at end of file +|StaticSiteItemFrontMatter|Defines and stores all possible static item front matter keys. Implements loading and saving from YAML, as well as loading and saving from a `OpenLiveWriter.Extensibility.BlogClient.BlogPost` instance.|| +|StaticSiteConfigFrontMatterKeys|A subset of the static site config, `StaticSiteConfigFrontMatterKeys` contains the key names for each of the supported front-matter attributes. Used to support different static site generators.|| \ No newline at end of file diff --git a/docs/diagrams/StaticSiteClassDiagram.drawio b/docs/diagrams/StaticSiteClassDiagram.drawio index 6a8fb0ff..745718d9 100644 --- a/docs/diagrams/StaticSiteClassDiagram.drawio +++ b/docs/diagrams/StaticSiteClassDiagram.drawio @@ -1 +1 @@ -7Vpbb6M4FP41eZwIm/vjNG13Z7fdqZSRKs2bCw54x9jIOLf59WMHEyCQNG0uZVcjVQ0+PhhzvvN9PmBG9iRb/SFQnj7yGNMRtOLVyL4dQQgcCEf6z4rXpSWwjCERJDZOtWFKfmJjtIx1TmJctBwl51SSvG2MOGM4ki0bEoIv224zTttXzVGCO4ZphGjX+kximZq7cK3a/icmSVpdGVimJ0OVszEUKYr5smGy70b2RHAuy6NsNcFUB6+KS3ne/Z7e7cQEZvKYEyTg0V8Ji8Fy4hb+gq9usfsJBOUwC0Tn5o7NbOW6CkEi+DzvXs1MYIGFxKs+LNBLNUJ9uypPMM+wFGvlZ84KTYBMhjimuazD7QO3tKWNUDtVpJGBONmOXEdBHZhAvCUo9utBUWjm+lAnFBYj+2bGmZyafqDaRY4iwpJvPNcGS1lUQKoUsqFXGra5owOkDU+8IJJwpkwUz1TPTSozasbsgnAY1F1ouhBcJciP0P7n50NBJtPk+yydL7Ivt84npxNSHCvmmSYXMuUJZ4je1dYblYgsxnpUHc/a54GXUVbGf7GUayMjaC55O4CYxZ+1KKhmTFDGWfwtJazsuCe04WaGgNY27Hp6e6l3EIeCz0WED8TC5JtEIsEHB+wHUWCKJFm0Z9cH2OZUFQC0bjjknDBZNEZ+0oaantD3WvwE/o7O7PiDABzyVwflDOrU2d7KCZTtYaxHNX2IOkj0QURRoW7TqjrUdbZ9U6kCGE2JxBNKNKi7udnIoWWq3KaK3bprqVa9ixCz0sZwHPrACwMAbGj5rtsKrduVSuCBcRB4fggdFwZ2tdo2Oe1eSjfh2UDgbEaSwYBg23DsejAIbSsAvgeGjIE/UFm19snqu1T0UPodp6IdPT9BVk8CrK/WOIE0t1iq0ouLwZDHdawxUP+CwHItGziDVrCgE7bf7OnP14GwJxwoYHuryPMVjR8md3vKPtheF+Huk0N5Q+asGva3lqPhwepyGNWo87qmq1+UaeGl3RZ6KaRAkdxa22dUrY3vi3jbKvFF4mwwa8Ph6taGw1ocqldS/3Ox6XV0jxQbZ1Crg3uu2kqz5l5wJh+RlHhYxZW178lkcPwBA+XPFaor70j+wEHxB3Tfe/5GrF9jBoKY97riqdpirmuLt0ne33hd/DdkD3jue2TPv5jsHYEJQxkuNsHrh+VrjtmDSp5noaIsxjeUJ+WLynH5U4xr4DooqaDu7COoFOA/8IRTLpSFcaZ5O1PU2jEhShK9ExGpS2w2OTREJEL0s+nISBxvSN8Hf1sIzp8MDXy3S10TUXiprQv3g1XxhfLoR68mlsBWu0ztuhDY19jKOPap1LmSSh6a5Ol14RMv3rlX0LNteiQI+5+mdh6mYEsWYSV6168GezHwBkuiHcp0OXVxEh27H/ihJDrbi+sn/QnGUEgEQnfsNGnkfBCLVLP+NqR8MVV/YWPf/QI= \ No newline at end of file +7Vpbb+MoFP41eZzI4Gsep2m7O7vtbqWMNNK+UZvY7GCIMLnNr1+IcXxNmk6SBq1Gqhp8OGA4H9/HsfHIneab3wRaZM88wXQEnWQzcu9HEAIPwpH+c5JtaQk9UBpSQRLjVBtm5Ac2RsdYlyTBRctRck4lWbSNMWcMx7JlQ0Lwddttzmn7rguU4p5hFiPat34jicxKa+Q7tf13TNKsujNwTE2OKmdjKDKU8HXD5D6M3KngXJalfDPFVAevikvZ7vFA7X5gAjN5SgMJePxHyhKwnvpFuOKbe+x/AlHZzQrRpZmxGa3cViFIBV8u+nczA1hhIfFmCAv0WvVQT1etE8xzLMVW+a3rgIbAL9tmjWB6VSyRATHdt63nqQpmqu+Ztvv2tBVeC13USwaLkXs350zOTD1Q18UCxYSlX/lCGxxlUVOuFokLg9KwXx06BNrwwgsiCWfKRPFc1dxlMqemz36Yj8PWDf6NgvwM3b9+PBVkOkv/mWfLVf7l3vvk9UKKE8Utc8mFzHjKGaIPtfVOLTWWYN2rjmft88TLKCvjv1jKrREKtJS8HUDMks+a9uoyISjnLPmaEVZWPBLacDNdQGcfdj28g+Q6ikPBlyLGR2Jh1ptEIsVHOxwGUWCKJFm1RzcE2K6pCgDaNhwWnDBZNHp+0QblYFYODIOyR6PRIOwoSccfROCYvyqUI6iXzn4qZ1B2gLEB1fQhqpDqQkxRoabpVBXqPvu6mVQBjGdE4iklGtTu2mysoXWm3GaK3bpqrfa1qxDT1E4m40kIgkkEgAud0Pdboa32mQaLQQDGURSEE+j5MHId2Oe0fy3dhBcDgbM5Sa0BwXXh2A9gNHGdCIQBsBmD0FJZdQ7J6k+p6LHld5qK9vT8DFk9C7ChXOMM0txjqZIrLqwhj+85Y6D+RZHjOy7wrFawqBe2X+wZXq+WsGdiKWAHs8jLJY03k7sDaR9s74uw++RQTsi0qmF/bzo6OZpd2pGNem9ruvpFuRZe2r9Cr4UUKJZ7a7tFdbXzfRXv2yW+SJxbszccz25daNfmUL10+p+LzaCjf6LYeFbtDv6lcivNmkfBmXxGUmKLkivXGTuHnkys4w+wlD8fkF0FJ/IHWsUf0H/v+QuxYY2xBLHgbcVTucVS5xYnPU42RO9PvC3sEb5K26q0LvD7WhcNqFt4NXU7IfQM5bjYRWg4+n8vMHtSa+SbUKEU4zvK0/J95Lj8KcY1Pj0oVOQ6xwUKaf5dAUm5UBbGmabnXDGoY0KUpPrAIVa32J1laBxIjOhnU5GTJNlxewjjNt8vj3gD0f2O1kQUXuuEwr+x+L1SHn8flL4S2OowqZ3+AfcjTixOffj0PkgMjw3y/PTvhRc/eSQwcP55IgiHH5o6z0ywJYSwSuk+PukbxCCwlkQdyvQ5dXUSnXrsd1MSXez99Iv+lsIWEoGJP/aaNPJuxCJ1WX/kUb5/qj+VcR/+Aw== \ No newline at end of file diff --git a/docs/images/StaticSiteClassDiagram.png b/docs/images/StaticSiteClassDiagram.png index 1f0804f8..5d8ec97f 100644 Binary files a/docs/images/StaticSiteClassDiagram.png and b/docs/images/StaticSiteClassDiagram.png differ