优化README文档
1. 添加主题预览图 2. 改进文档结构和导航 3. 增强使用说明 4. 添加许可证文件
This commit is contained in:
674
LICENSE
674
LICENSE
@@ -1,21 +1,661 @@
|
|||||||
MIT License
|
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 19 November 2007
|
||||||
|
|
||||||
Copyright (c) 2025 Zuoling Rong
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
Preamble
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
|
||||||
in the Software without restriction, including without limitation the rights
|
|
||||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
||||||
copies of the Software, and to permit persons to whom the Software is
|
|
||||||
furnished to do so, subject to the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in all
|
The GNU Affero General Public License is a free, copyleft license for
|
||||||
copies or substantial portions of the Software.
|
software and other kinds of works, specifically designed to ensure
|
||||||
|
cooperation with the community in the case of network server software.
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
The licenses for most software and other practical works are designed
|
||||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
to take away your freedom to share and change the works. By contrast,
|
||||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
our General Public Licenses are intended to guarantee your freedom to
|
||||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
share and change all versions of a program--to make sure it remains free
|
||||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
software for all its users.
|
||||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
||||||
SOFTWARE.
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
Developers that use our General Public Licenses protect your rights
|
||||||
|
with two steps: (1) assert copyright on the software, and (2) offer
|
||||||
|
you this License which gives you legal permission to copy, distribute
|
||||||
|
and/or modify the software.
|
||||||
|
|
||||||
|
A secondary benefit of defending all users' freedom is that
|
||||||
|
improvements made in alternate versions of the program, if they
|
||||||
|
receive widespread use, become available for other developers to
|
||||||
|
incorporate. Many developers of free software are heartened and
|
||||||
|
encouraged by the resulting cooperation. However, in the case of
|
||||||
|
software used on network servers, this result may fail to come about.
|
||||||
|
The GNU General Public License permits making a modified version and
|
||||||
|
letting the public access it on a server without ever releasing its
|
||||||
|
source code to the public.
|
||||||
|
|
||||||
|
The GNU Affero General Public License is designed specifically to
|
||||||
|
ensure that, in such cases, the modified source code becomes available
|
||||||
|
to the community. It requires the operator of a network server to
|
||||||
|
provide the source code of the modified version running there to the
|
||||||
|
users of that server. Therefore, public use of a modified version, on
|
||||||
|
a publicly accessible server, gives the public access to the source
|
||||||
|
code of the modified version.
|
||||||
|
|
||||||
|
An older license, called the Affero General Public License and
|
||||||
|
published by Affero, was designed to accomplish similar goals. This is
|
||||||
|
a different license, not a version of the Affero GPL, but Affero has
|
||||||
|
released a new version of the Affero GPL which permits relicensing under
|
||||||
|
this license.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU Affero General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Remote Network Interaction; Use with the GNU General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, if you modify the
|
||||||
|
Program, your modified version must prominently offer all users
|
||||||
|
interacting with it remotely through a computer network (if your version
|
||||||
|
supports such interaction) an opportunity to receive the Corresponding
|
||||||
|
Source of your version by providing access to the Corresponding Source
|
||||||
|
from a network server at no charge, through some standard or customary
|
||||||
|
means of facilitating copying of software. This Corresponding Source
|
||||||
|
shall include the Corresponding Source for any work covered by version 3
|
||||||
|
of the GNU General Public License that is incorporated pursuant to the
|
||||||
|
following paragraph.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the work with which it is combined will remain governed by version
|
||||||
|
3 of the GNU General Public License.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU Affero General Public License from time to time. Such new versions
|
||||||
|
will be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU Affero General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU Affero General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU Affero General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU Affero General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU Affero General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Affero General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If your software can interact with users remotely through a computer
|
||||||
|
network, you should also make sure that it provides a way for users to
|
||||||
|
get its source. For example, if your program is a web application, its
|
||||||
|
interface could display a "Source" link that leads users to an archive
|
||||||
|
of the code. There are many ways you could offer source, and different
|
||||||
|
solutions will be better for different programs; see section 13 for the
|
||||||
|
specific requirements.
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU AGPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
|
|||||||
375
README.md
375
README.md
@@ -1,30 +1,54 @@
|
|||||||
# <img src="assets/favicon.ico" width="48" style="vertical-align: middle;"> MeNav - 个人导航站
|
# <img src="assets/favicon.ico" width="48" style="vertical-align: middle;"> MeNav - 个人导航站
|
||||||
|
|
||||||
一键部署的静态个人导航站 | 自动化构建 | 支持书签导入
|
[](https://www.gnu.org/licenses/agpl-3.0.html)
|
||||||
|
[](https://github.com/rbetree/menav/stargazers)
|
||||||
|
[](https://github.com/rbetree/menav/network/members)
|
||||||
|
|
||||||
|
📋 一键部署的静态个人导航站 | ⚡ 自动化构建 | 🔖 支持书签导入
|
||||||
|
|
||||||
|
> MeNav是一个轻量级、高度可定制的个人导航网站生成器,让您轻松创建属于自己的导航主页。无需数据库和后端服务,完全静态部署,支持一键Fork部署到GitHub Pages,还可以从浏览器书签一键导入网站。MeNav is a lightweight, highly customizable personal navigation website generator. One-click deployment to GitHub Pages, automated build, bookmark import support, and more.
|
||||||
|
|
||||||
如果觉得项目有用,欢迎⭐Star/Fork支持,谢谢!
|
如果觉得项目有用,欢迎⭐Star/Fork支持,谢谢!
|
||||||
|
|
||||||
|
|
||||||
|
## 预览 | Preview
|
||||||
|
|
||||||
|
<table>
|
||||||
|
<tr>
|
||||||
|
<td><b>明亮主题 | Light Theme</b></td>
|
||||||
|
<td><b>黑暗主题 | Dark Theme</b></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><img src="assets/preview_light.png" alt="明亮主题预览" /></td>
|
||||||
|
<td><img src="assets/preview_dark.png" alt="黑暗主题预览" /></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
## 目录
|
## 目录
|
||||||
|
|
||||||
- [在线预览](#在线预览)
|
- [预览](#预览--preview)
|
||||||
- [功能特点](#功能特点)
|
- [功能特点](#功能特点)
|
||||||
- [近期更新](#近期更新)
|
- [近期更新](#近期更新)
|
||||||
- [技术栈](#技术栈)
|
- [技术栈](#技术栈)
|
||||||
- [项目结构](#项目结构)
|
- [项目结构](#项目结构)
|
||||||
- [快速开始](#快速开始)
|
- [快速开始](#快速开始)
|
||||||
- [部署方式](#部署方式)
|
- [部署方式](#部署方式)
|
||||||
- [快速部署到GitHub Pages](#快速部署到github-pages)
|
- [部署到GitHub Pages](#快速部署到github-pages)
|
||||||
- [部署到服务器](#部署到服务器)
|
- [部署到自己的服务器](#部署到服务器)
|
||||||
- [设置配置文件](#设置配置文件)
|
- [其他CI/CD服务部署](#其他cicd托管选项)
|
||||||
- [使用双文件配置](#使用双文件配置)
|
- [配置指南](#设置配置文件)
|
||||||
- [使用模块化配置](#使用模块化配置)
|
- [配置方式对比](#配置方式对比)
|
||||||
- [书签导入功能](#书签导入功能)
|
- [双文件配置](#使用双文件配置)
|
||||||
- [贡献](#贡献)
|
- [模块化配置(推荐)](#使用模块化配置)
|
||||||
|
- [配置详解](#配置详解)
|
||||||
|
- [书签导入](#书签导入功能)
|
||||||
|
- [常见问题](#常见问题)
|
||||||
|
- [贡献指南](#贡献指南)
|
||||||
- [许可证](#许可证)
|
- [许可证](#许可证)
|
||||||
|
|
||||||
## 在线预览
|
## 快速预览
|
||||||
|
|
||||||
访问:[在线DEMO](https://rbetree.github.io/menav/)
|
[在线访问](https://rbetree.github.io/menav/)
|
||||||
|
|
||||||
## 功能特点
|
## 功能特点
|
||||||
|
|
||||||
@@ -33,10 +57,10 @@
|
|||||||
- 🔍 实时搜索功能
|
- 🔍 实时搜索功能
|
||||||
- 🎯 分类展示网站链接
|
- 🎯 分类展示网站链接
|
||||||
- 👥 支持展示社交媒体链接
|
- 👥 支持展示社交媒体链接
|
||||||
- 📝 支持多个内容页面(首页、项目、文章、友链)
|
- 📝 支持多个内容页面
|
||||||
- 📌 支持从浏览器导入书签
|
- 📌 支持从浏览器导入书签
|
||||||
- 🧩 模块化配置/双文件配置
|
- 🧩 模块化配置/双文件配置
|
||||||
- 🔄 可部署到GitHub Pages或任何服务器
|
- 🔄 可部署到GitHub Pages或任何类似的CI/CD服务,及任何服务器
|
||||||
|
|
||||||
## 近期更新
|
## 近期更新
|
||||||
|
|
||||||
@@ -97,11 +121,11 @@
|
|||||||
- HTML5 + CSS3
|
- HTML5 + CSS3
|
||||||
- JavaScript (原生)
|
- JavaScript (原生)
|
||||||
- Font Awesome 图标
|
- Font Awesome 图标
|
||||||
- GitHub Pages托管
|
- GitHub Pages托管/其他各种CI/CD服务托管
|
||||||
|
|
||||||
## 项目结构
|
## 项目结构
|
||||||
|
|
||||||
```
|
```bash
|
||||||
menav/
|
menav/
|
||||||
├── assets/ # 静态资源文件
|
├── assets/ # 静态资源文件
|
||||||
│ ├── style.css # 样式表
|
│ ├── style.css # 样式表
|
||||||
@@ -133,6 +157,11 @@ menav/
|
|||||||
|
|
||||||
## 快速开始
|
## 快速开始
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>点击展开</summary>
|
||||||
|
|
||||||
|
通过以下步骤快速设置您的个人导航站:
|
||||||
|
|
||||||
1. 克隆仓库
|
1. 克隆仓库
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/rbetree/menav.git
|
git clone https://github.com/rbetree/menav.git
|
||||||
@@ -141,27 +170,39 @@ cd menav
|
|||||||
|
|
||||||
2. 安装依赖
|
2. 安装依赖
|
||||||
```bash
|
```bash
|
||||||
# 清理旧的依赖(如果需要)
|
# 安装依赖
|
||||||
rm -rf node_modules
|
|
||||||
rm -f package-lock.json
|
|
||||||
|
|
||||||
# 安装新的依赖
|
|
||||||
npm install
|
npm install
|
||||||
```
|
```
|
||||||
|
|
||||||
3. 修改配置
|
3. 修改配置
|
||||||
- 可以选择使用双文件配置或模块化配置(见[设置配置文件](#设置配置文件))
|
- 根据您的需求选择配置方式:
|
||||||
- 自定义网站内容、导航链接、社交媒体链接等
|
- 双文件配置:复制`config.yml`为`config.user.yml`并编辑
|
||||||
|
- 模块化配置:在`config/user/`目录下创建配置文件
|
||||||
|
- 自定义站点标题、描述、导航链接和网站分类等
|
||||||
|
|
||||||
4. 本地预览
|
4. 本地预览
|
||||||
```bash
|
```bash
|
||||||
|
# 启动开发服务器
|
||||||
npm run dev
|
npm run dev
|
||||||
```
|
```
|
||||||
|
|
||||||
|
5. 构建静态网站
|
||||||
|
```bash
|
||||||
|
# 生成静态HTML文件
|
||||||
|
npm run build
|
||||||
|
```
|
||||||
|
|
||||||
|
构建后的文件位于`dist`目录,可以部署到任何静态网站托管服务。
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
## 部署方式
|
## 部署方式
|
||||||
|
|
||||||
### 快速部署到GitHub Pages
|
### 快速部署到GitHub Pages
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>点击展开</summary>
|
||||||
|
|
||||||
#### 第一步:前置设置
|
#### 第一步:前置设置
|
||||||
|
|
||||||
1. Fork仓库:
|
1. Fork仓库:
|
||||||
@@ -185,6 +226,7 @@ npm run dev
|
|||||||
#### 第二步:自定义配置
|
#### 第二步:自定义配置
|
||||||
|
|
||||||
1. 创建个人配置文件:
|
1. 创建个人配置文件:
|
||||||
|
- **重要:** 始终创建自己的用户配置文件,不要直接修改默认配置文件
|
||||||
- 可以使用双文件配置或模块化配置
|
- 可以使用双文件配置或模块化配置
|
||||||
- 推荐使用模块化配置(见[使用模块化配置](#使用模块化配置))
|
- 推荐使用模块化配置(见[使用模块化配置](#使用模块化配置))
|
||||||
- 提交您的配置文件到仓库
|
- 提交您的配置文件到仓库
|
||||||
@@ -206,8 +248,13 @@ npm run dev
|
|||||||
- 找到失败的工作流
|
- 找到失败的工作流
|
||||||
- 点击 "Re-run all jobs" 重新运行
|
- 点击 "Re-run all jobs" 重新运行
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
### 部署到服务器
|
### 部署到服务器
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>点击展开</summary>
|
||||||
|
|
||||||
如果您想部署到自己的Web服务器,只需要以下几个步骤:
|
如果您想部署到自己的Web服务器,只需要以下几个步骤:
|
||||||
|
|
||||||
1. 构建静态网站:
|
1. 构建静态网站:
|
||||||
@@ -241,10 +288,50 @@ server {
|
|||||||
- 如果您想在服务器上更新网站,只需重复上述步骤1-2
|
- 如果您想在服务器上更新网站,只需重复上述步骤1-2
|
||||||
- 或者设置自动部署流程,例如使用GitLab CI/CD或Jenkins
|
- 或者设置自动部署流程,例如使用GitLab CI/CD或Jenkins
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
### 其他CI/CD托管选项
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>点击展开</summary>
|
||||||
|
|
||||||
|
除了GitHub Pages外,您还可以使用其他各种CI/CD服务部署MeNav:
|
||||||
|
|
||||||
|
1. **Vercel**:
|
||||||
|
- 在Vercel上导入您的GitHub仓库
|
||||||
|
- 设置构建命令为`npm run build`
|
||||||
|
- 设置输出目录为`dist`
|
||||||
|
|
||||||
|
2. **Netlify**:
|
||||||
|
- 连接您的GitHub仓库
|
||||||
|
- 设置构建命令为`npm run build`
|
||||||
|
- 发布目录设置为`dist`
|
||||||
|
|
||||||
|
3. **Cloudflare Pages**:
|
||||||
|
- 连接您的Git提供商
|
||||||
|
- 设置构建命令为`npm run build`
|
||||||
|
- 构建输出目录设置为`dist`
|
||||||
|
|
||||||
|
4. **GitLab Pages**:
|
||||||
|
- 创建`.gitlab-ci.yml`文件
|
||||||
|
- 配置Pages部署流程
|
||||||
|
- 指定构建输出目录
|
||||||
|
|
||||||
|
5. **Azure Static Web Apps**:
|
||||||
|
- 在Azure门户中创建新的静态Web应用
|
||||||
|
- 关联您的代码库
|
||||||
|
- 配置构建信息
|
||||||
|
|
||||||
|
无论选择哪种部署方式,请确保创建并使用您自己的配置文件,而不是直接修改默认配置。
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
## 设置配置文件
|
## 设置配置文件
|
||||||
|
|
||||||
MeNav支持两种配置方式:双文件配置和模块化配置(推荐)。
|
MeNav支持两种配置方式:双文件配置和模块化配置(推荐)。
|
||||||
|
|
||||||
|
> **🔔 重要提示:** 请务必创建并使用您自己的配置文件(`config.user.yml`或`config/user/`目录),不要直接修改默认配置文件,以便后续更新项目时不会丢失您的个性化设置。
|
||||||
|
|
||||||
在加载配置时遵循以下优先级顺序:
|
在加载配置时遵循以下优先级顺序:
|
||||||
1. `config/user/` (模块化用户配置)(优先级最高)
|
1. `config/user/` (模块化用户配置)(优先级最高)
|
||||||
2. `config.user.yml`和 `bookmarks.user.yml`(双文件用户配置)
|
2. `config.user.yml`和 `bookmarks.user.yml`(双文件用户配置)
|
||||||
@@ -253,16 +340,65 @@ MeNav支持两种配置方式:双文件配置和模块化配置(推荐)。
|
|||||||
|
|
||||||
**注意:** 各优先级配置间采用完全替换策略,而非合并。系统会选择存在的最高优先级配置,完全忽略其他低优先级配置。这确保了模块化配置和双文件配置都能独立使用,避免混合配置带来的意外行为。
|
**注意:** 各优先级配置间采用完全替换策略,而非合并。系统会选择存在的最高优先级配置,完全忽略其他低优先级配置。这确保了模块化配置和双文件配置都能独立使用,避免混合配置带来的意外行为。
|
||||||
|
|
||||||
|
### 配置方式对比
|
||||||
|
|
||||||
|
<table>
|
||||||
|
<tr>
|
||||||
|
<th>特性</th>
|
||||||
|
<th>双文件配置</th>
|
||||||
|
<th>模块化配置(推荐)</th>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>配置文件</td>
|
||||||
|
<td>两个主要文件:<code>config.user.yml</code> 和 <code>bookmarks.user.yml</code></td>
|
||||||
|
<td>分散到多个文件:<code>config/user/site.yml</code>, <code>navigation.yml</code>, <code>pages/*.yml</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>适用场景</td>
|
||||||
|
<td>小型网站,快速开始</td>
|
||||||
|
<td>复杂网站,长期维护</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>关注点分离</td>
|
||||||
|
<td>所有配置集中在一个文件</td>
|
||||||
|
<td>每个页面和功能区域有专属配置文件</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>兼容性</td>
|
||||||
|
<td>传统方式,简单直接</td>
|
||||||
|
<td>完全兼容传统方式,不影响旧版本</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
### 使用双文件配置
|
### 使用双文件配置
|
||||||
|
|
||||||
双文件配置由 `config.yml`/`config.user.yml` 和 `bookmarks.yml`/`bookmarks.user.yml` 两个文件组成,适合小型网站和快速开始。
|
双文件配置由 `config.yml`/`config.user.yml` 和 `bookmarks.yml`/`bookmarks.user.yml` 两个文件组成,适合小型网站和快速开始。
|
||||||
|
|
||||||
1. **创建配置文件**:
|
* **创建配置文件**:
|
||||||
- 复制 `config.yml` 为 `config.user.yml`
|
- 复制 `config.yml` 为 `config.user.yml`
|
||||||
- 对于书签配置,请勿手动创建 `bookmarks.user.yml`,它应通过[书签导入功能](#书签导入功能)自动生成
|
- 对于书签配置,请勿手动创建 `bookmarks.user.yml`,它应通过[书签导入功能](#书签导入功能)自动生成
|
||||||
- 编辑 `config.user.yml` 添加您的配置
|
- 编辑 `config.user.yml` 添加您的配置
|
||||||
|
|
||||||
2. **配置文件结构**:
|
### 使用模块化配置
|
||||||
|
|
||||||
|
模块化配置将配置分散到多个文件中,更易于管理和维护,推荐用于复杂网站。
|
||||||
|
|
||||||
|
* **创建配置目录**:
|
||||||
|
- 在`config/user/`目录下创建您的自定义配置文件
|
||||||
|
- 可以参考项目结构中的`config/_default/`目录结构
|
||||||
|
- 至少需要创建`site.yml`和`navigation.yml`
|
||||||
|
|
||||||
|
### 配置详解
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>点击展开</summary>
|
||||||
|
|
||||||
|
以下是配置文件各部分的详细说明,适用于双文件配置和模块化配置两种方式。
|
||||||
|
|
||||||
|
#### 配置文件结构
|
||||||
|
|
||||||
|
配置文件使用YAML格式,包含多个关键部分:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# 网站基本信息
|
# 网站基本信息
|
||||||
site:
|
site:
|
||||||
@@ -312,8 +448,10 @@ categories:
|
|||||||
# 更多配置...
|
# 更多配置...
|
||||||
```
|
```
|
||||||
|
|
||||||
3. **添加网站链接**:
|
#### 添加网站链接
|
||||||
在 `config.user.yml` 中的 categories 部分添加新站点:
|
|
||||||
|
在配置文件中的 categories 部分添加新站点:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
categories:
|
categories:
|
||||||
- name: 分类名称
|
- name: 分类名称
|
||||||
@@ -325,12 +463,15 @@ categories:
|
|||||||
description: 网站描述
|
description: 网站描述
|
||||||
```
|
```
|
||||||
|
|
||||||
4. **设置网站字体**:
|
#### 设置网站字体
|
||||||
- `family`: 字体名称,支持Web安全字体或Google Fonts
|
|
||||||
- `weight`: 字体粗细,常用值如400(常规)、500(中等)、600(粗体)等
|
|
||||||
- `source`: 字体来源,可选"google"或"system"
|
|
||||||
|
|
||||||
例如使用Google字体:
|
字体配置有三个关键属性:
|
||||||
|
|
||||||
|
- `family`: 字体名称,支持Web安全字体或Google Fonts
|
||||||
|
- `weight`: 字体粗细,常用值如400(常规)、500(中等)、600(粗体)等
|
||||||
|
- `source`: 字体来源,可选"google"或"system"
|
||||||
|
|
||||||
|
例如使用Google字体:
|
||||||
```yaml
|
```yaml
|
||||||
fonts:
|
fonts:
|
||||||
body:
|
body:
|
||||||
@@ -339,90 +480,152 @@ fonts:
|
|||||||
source: "google"
|
source: "google"
|
||||||
```
|
```
|
||||||
|
|
||||||
5. **设置网站图标**:
|
#### 设置网站图标
|
||||||
- 支持.ico、.png等格式
|
|
||||||
- 建议尺寸为32x32或16x16像素
|
|
||||||
- 将图标文件放在assets目录下
|
|
||||||
- 在配置文件中设置:`favicon: favicon.ico`
|
|
||||||
|
|
||||||
### 使用模块化配置
|
网站图标设置提示:
|
||||||
|
|
||||||
模块化配置将配置分散到多个文件中,更易于管理和维护,推荐用于复杂网站。
|
- 支持.ico、.png等格式
|
||||||
|
- 建议尺寸为32x32或16x16像素
|
||||||
|
- 将图标文件放在assets目录下
|
||||||
|
- 在配置文件中设置:`favicon: favicon.ico`
|
||||||
|
|
||||||
#### 模块化配置目录结构
|
#### 使用Font Awesome图标
|
||||||
|
|
||||||
```
|
MeNav使用Font Awesome图标库为网站分类和链接提供图标:
|
||||||
config/
|
|
||||||
├── _default/ # 默认配置
|
- **图标类名**:使用Font Awesome 5的图标类名,例如`fas fa-home`、`fab fa-github`等
|
||||||
│ ├── site.yml # 网站基本信息、字体等
|
- **查找图标**:可在[Font Awesome官网](https://fontawesome.com/icons)浏览和搜索图标
|
||||||
│ ├── navigation.yml # 导航菜单配置
|
- **常用图标前缀**:
|
||||||
│ └── pages/ # 页面配置
|
- `fas`:实心风格图标 (Font Awesome Solid)
|
||||||
│ ├── home.yml # 首页配置
|
- `far`:线框风格图标 (Font Awesome Regular)
|
||||||
│ ├── projects.yml # 项目页配置
|
- `fab`:品牌图标 (Font Awesome Brands)
|
||||||
│ ├── articles.yml # 文章页配置
|
|
||||||
│ ├── friends.yml # 朋友页配置
|
示例:
|
||||||
│ └── bookmarks.yml # 书签页配置
|
```yaml
|
||||||
└── user/ # 用户自定义配置(可选覆盖)
|
# 分类图标
|
||||||
├── site.yml # 用户网站配置
|
categories:
|
||||||
├── navigation.yml # 用户导航配置
|
- name: "常用工具"
|
||||||
└── pages/ # 用户页面配置
|
icon: "fas fa-tools"
|
||||||
├── home.yml # 用户首页配置
|
sites:
|
||||||
# 其他用户自定义页面...
|
- name: "GitHub"
|
||||||
|
url: "https://github.com"
|
||||||
|
icon: "fab fa-github"
|
||||||
|
description: "全球最大的代码托管平台"
|
||||||
|
- name: "谷歌搜索"
|
||||||
|
url: "https://google.com"
|
||||||
|
icon: "fab fa-google"
|
||||||
|
description: "全球最大的搜索引擎"
|
||||||
```
|
```
|
||||||
|
|
||||||
#### 使用模块化配置的优势
|
**提示**:书签导入功能会根据网站URL自动匹配适合的Font Awesome图标。如需自定义,可在导入后编辑配置文件修改图标类名。
|
||||||
|
|
||||||
1. **分离关注点**:每个页面和功能区域有专属配置文件
|
|
||||||
2. **简化编辑**:修改特定页面时只需编辑对应文件
|
|
||||||
3. **更好的版本控制**:减少合并冲突
|
|
||||||
4. **向后兼容**:仍然支持传统的 `config.yml` 和 `config.user.yml`
|
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
## 书签导入功能
|
## 书签导入功能
|
||||||
|
|
||||||
MeNav支持从浏览器导入书签,快速批量添加网站链接。
|
MeNav支持从浏览器导入书签,快速批量添加网站链接,无需手动录入。
|
||||||
|
|
||||||
在加载配置时遵循以下优先级顺序:
|
### 配置加载优先级
|
||||||
|
|
||||||
|
书签配置按以下优先级加载(从高到低):
|
||||||
|
|
||||||
1. `config/user/pages/bookmarks.yml` (模块化用户配置)
|
1. `config/user/pages/bookmarks.yml` (模块化用户配置)
|
||||||
2. `bookmarks.user.yml`(双文件用户配置的书签部分)
|
2. `bookmarks.user.yml`(双文件用户配置)
|
||||||
3. `config/_default/pages/bookmarks.yml` (模块化默认配置)
|
3. `config/_default/pages/bookmarks.yml` (模块化默认配置)
|
||||||
4. `bookmarks.yml`(双文件默认配置的书签部分)
|
4. `bookmarks.yml`(双文件默认配置)
|
||||||
|
|
||||||
**注意:** 与主配置一样,书签配置也采用完全替换策略,系统只会使用找到的最高优先级书签配置,完全忽略低优先级配置。
|
**注意:** 与主配置一样,书签配置采用完全替换策略,系统只会使用找到的最高优先级配置。
|
||||||
|
|
||||||
### 导入步骤
|
### 导入步骤详解
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>点击展开</summary>
|
||||||
|
|
||||||
1. **从浏览器导出书签**
|
1. **从浏览器导出书签**
|
||||||
- 在Chrome中: 打开书签管理器 -> 点击"更多"(三个点) -> 导出书签
|
|
||||||
- 在Firefox中: 打开书签库 -> 显示所有书签 -> 导入和备份 -> 导出书签为HTML
|
**Chrome**:
|
||||||
- 在Edge中: 设置 -> 收藏夹 -> 管理收藏夹 -> 导出为HTML文件
|
- 打开Chrome菜单 (右上角三点图标)
|
||||||
|
- 选择"书签" > "书签管理器"
|
||||||
|
- 点击右上角三点图标,选择"导出书签"
|
||||||
|
- 保存HTML文件到本地
|
||||||
|
|
||||||
|
**Firefox**:
|
||||||
|
- 点击书签菜单按钮
|
||||||
|
- 选择"管理书签"
|
||||||
|
- 在菜单栏选择"导入和备份" > "导出书签到HTML"
|
||||||
|
- 保存文件到本地
|
||||||
|
|
||||||
|
**Edge**:
|
||||||
|
- 打开菜单 (右上角三点图标)
|
||||||
|
- 选择"收藏夹"
|
||||||
|
- 点击"更多选项" > "导出收藏夹"
|
||||||
|
- 保存为HTML文件
|
||||||
|
|
||||||
2. **导入书签到MeNav**
|
2. **导入书签到MeNav**
|
||||||
- 在项目根目录下创建 `bookmarks` 文件夹(如果不存在)
|
|
||||||
- 将导出的HTML书签文件放入 `bookmarks` 文件夹
|
|
||||||
- 提交并推送变更到仓库
|
|
||||||
- 系统会自动处理书签文件并生成配置文件
|
|
||||||
|
|
||||||
3. **书签处理结果**
|
**GitHub Pages方式**:
|
||||||
- 生成的书签配置会保存到 `bookmarks.user.yml`
|
- Fork本仓库后,在您的仓库中创建`bookmarks`目录
|
||||||
- 如果使用模块化配置,也会同时保存到 `config/user/pages/bookmarks.yml`
|
- 上传HTML格式书签文件到此目录
|
||||||
- 自动开始构建
|
- GitHub Actions会自动处理文件并生成配置
|
||||||
|
|
||||||
### 注意事项
|
**本地开发方式**:
|
||||||
|
- 在项目根目录创建`bookmarks`文件夹
|
||||||
|
- 复制HTML书签文件到此文件夹
|
||||||
|
- 运行`npm run import-bookmarks`命令处理书签文件
|
||||||
|
- 系统生成配置文件后即可使用`npm run dev`预览
|
||||||
|
|
||||||
- 仅支持标准HTML格式的书签文件
|
3. **处理结果**
|
||||||
|
|
||||||
|
处理完成后:
|
||||||
|
- 书签分类会变成网站分类
|
||||||
|
- 书签文件夹结构会被保留
|
||||||
|
- 系统自动尝试匹配网站图标
|
||||||
|
- 生成的配置可在`bookmarks.user.yml`或`config/user/pages/bookmarks.yml`中查看和编辑
|
||||||
|
|
||||||
|
### 书签导入注意事项
|
||||||
|
|
||||||
|
- 仅支持标准HTML格式的书签文件(大多数浏览器导出格式)
|
||||||
- 每次只会处理目录中最新的一个书签文件
|
- 每次只会处理目录中最新的一个书签文件
|
||||||
- 处理完成后,书签文件会被自动清除,以防止重复处理
|
- 文件夹结构会保留,但可能需要手动调整图标和描述
|
||||||
|
- 处理完成后,原始书签文件会被自动删除,以防止重复处理
|
||||||
|
</details>
|
||||||
|
|
||||||
## 贡献
|
## 常见问题
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>为什么推荐使用模块化配置而非双文件配置?</summary>
|
||||||
|
模块化配置将不同功能的配置分散到多个文件中,便于管理和维护。当网站内容较多时,单一配置文件会变得臃肿难以编辑,而模块化配置则可以让您只关注需要修改的部分。
|
||||||
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>如何更改网站的主题或样式?</summary>
|
||||||
|
目前MeNav采用统一的设计风格,您可以通过修改`config/user/site.yml`(或`config.user.yml`)中的字体设置来调整网站外观。未来版本将考虑增加主题切换功能。
|
||||||
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>可以添加自定义JS脚本吗?</summary>
|
||||||
|
当前版本不直接支持添加自定义JS。如果您需要此功能,可以考虑Fork项目后修改`templates/index.html`模板文件,添加您的自定义脚本。
|
||||||
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>导入的书签没有正确显示图标怎么办?</summary>
|
||||||
|
系统会尝试根据网址自动匹配Font Awesome图标。如果匹配不理想,您可以手动编辑`bookmarks.user.yml`或`config/user/pages/bookmarks.yml`,修改每个站点的icon属性。
|
||||||
|
</details>
|
||||||
|
|
||||||
|
## 贡献指南
|
||||||
|
|
||||||
欢迎通过 Issues 或 Pull Requests 的形式做出贡献。如果您有好的想法或发现了问题,请随时提出。
|
欢迎通过 Issues 或 Pull Requests 的形式做出贡献。如果您有好的想法或发现了问题,请随时提出。
|
||||||
|
|
||||||
## 许可证
|
## 许可证
|
||||||
|
|
||||||
AGPL-3.0 License
|
[](https://www.gnu.org/licenses/agpl-3.0.html)
|
||||||
|
|
||||||
This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
|
MeNav 基于 GNU Affero General Public License v3.0 (AGPL-3.0) 开源许可证发布。
|
||||||
|
|
||||||
This program requires that modified versions must also be made available under the same license when used over a network.
|
主要条款:
|
||||||
|
- 允许商业使用、修改、分发、专利使用和私人使用
|
||||||
|
- 不提供任何担保
|
||||||
|
- 修改后的代码必须使用相同许可证
|
||||||
|
- 网络使用也视为分发,必须开源
|
||||||
|
|
||||||
|
在使用本项目时,请确保遵守AGPL-3.0协议的所有条款。完整许可证文本可在[LICENSE](LICENSE)文件中查看。
|
||||||
|
|||||||
BIN
assets/preview_dark.png
Normal file
BIN
assets/preview_dark.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 566 KiB |
BIN
assets/preview_light.png
Normal file
BIN
assets/preview_light.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 560 KiB |
Reference in New Issue
Block a user